Manchmal sehe ich PHP-Kommentare mit '@' vor einigen Zeilen. Wie @Author. Gibt es einen besonderen Grund dafür? Ich kann nichts darüber finden. Ich gehe davon aus, dass es einen stark genutzten Parser gibt, der nach @ sucht.Warum das '@' in den Kommentaren?
Dies ist höchstwahrscheinlich phpDocumentor Notation, ein Programm, das Quellcode (und diese @ Kommentare) analysiert, um Dokumentation automatisch zu generieren. Viele IDEs bieten auch intelligente Lookup- und Autocomplete-Funktionen basierend auf diesen Kommentaren.
Beispiel:
/**
* Echoes "example".
* @author Pekka
* @version 1.5
* @return void
*/
function example()
{
echo "example";
}
Lustig, wie ich hätte vergessen können, wenn ich nur eine phpDocumentor-related Antwort letzte Woche zur Verfügung gestellt. +1 – BoltClock
Ich weiß, dass Sie das wissen, denken Sie nur, dass es nützlich sein wird, zu der Antwort hinzuzufügen, dass phpdoc Kommentare auch von IDEs in Autocomplete verwendet werden. – zerkms
Danke für die schnelle Antwort. Ich dachte, das ist es, jetzt kenne ich das Programm. Ich habe nie daran gedacht, "Documenter" zu googeln. Macht Sinn. – Jason
Dies wird durch die automatische Dokumentation Generatoren verwendet wird Dokumentation aus den Kommentaren zu erstellen. Es gibt ein paar Tools und Formate gibt:
Um nur einige aufzuführen.
Es gibt viele Pakete, die Quellcode für Kommentare analysieren und komplizierte Hilfedateien in verschiedenen Formaten erstellen (wie HTML, Windows .chm-Dateien usw.). Java hat offensichtlich Javadoc, aber es gibt auch Doxygen und Doc-O-Matic, um nur einige zu nennen.
google: "php documenter" –