Technischer Name für langen beschreibenden Codeblock vor Klassen, Funktionen usw.

Question

Ich weiß, dass in PHP (wie viele andere Sprachen) beschreibende Kommentarblöcke mit Sternen vor jeder Zeile vor Klassen, Funktionen und Dateien eingefügt werden. Haben sie einen offiziellen Namen?

/** 
* 
* Do these types of bullet-ed block comments have any official name? 
* 
*/ 

Answer 1

Das kommt von Java Zusammenhang genannt JavaDoc, wo Sie einen Absatz von Details, einschließlich, aber nicht beschränkt auf, Parameter, Rückgabewerte begrenzt, usw.

Bei Java ...

Ein Dokumentationskommentar wird durch Schrägstrich-Stern-Stern und Stern-Schrägstrich eingerahmt (dh/** ... * /). Die Dokumentation ist im HTML-Format.

Das HTML-Format wird dann von Eclipse oder Netbeans oder anderen ähnlichen IDEs als Tipp für die jeweilige Funktion gerendert.

Der JavaDoc ist nur der Name, aber er kann für alle Sprachen verwendet werden.

Ein Beispiel für JavaDoc für Hinting in Eclipse ist mit (Code Assist) ist:

:

In NetBeans, wenn die Dokumentation nicht in PHP gefunden In NetBeans mit PHPDocs:

Und es zeigt in NetBeans auf diese Weise:

Answer 2

Sie sind DocBlocks genannt. Für PHP gibt es eine akzeptierte Syntax, die implemented by phpDocumentor

In Wirklichkeit war ein DocBlock in der Tat ist der Name für eine Kombination aus a, so genannten, DocComment und ein Block der PHPDoc Domain Specific Language (DSL). Ein DocComment ist der Container, der Dokumentation enthält, die nach dem PHPDoc-Standard formatiert werden kann.

A DocComment beginnt mit einem Schrägstrich und zwei Sternchen (/**), die ähnlich ist, wie Sie ein mehrzeiliges Kommentar beginnen, aber mit einem zusätzlichen Stern, und endet mit einem Sternchen und einem Schrägstrich (*/). DocComments kann eine einzelne Zeile in der Größe sein, aber auch mehrere Zeilen umfassen. In diesem Fall muss jede Zeile mit einem Stern beginnen. Es ist üblich und empfohlen, die Sternchen beim Überspannen mehrerer Linien vertikal auszurichten.