|
Anzeige
|
Was bedeuten Kommentrar wie " @name" oder "@brief"
Gast
#490995
Hallo zusammen, ich programiere in letzter Zeit mehr und mehr, und versuche mir unbedingt eine ordentliche Kommentierung angzuewöhnen. Bei der LCD.h von Peter Fleury verwendet er bei den Komentaren oft ausdrücke wie : @name ,@brief .... Haben diese Ausdrücke eine tiefere Bedeutung? Vielen Dank Ignaz Das sind spezielle Kommenatare für Dokumentationswerkzeuge. Diese Programme nehmen sich einen Quelltext vor, und holen diese speziellen Kommentare heraus, formatieren sie um und erstellen zb. eine HTML Dokumentation. Ein bekanntes System ist zb. Doxygen. Das sind Anweisungen für eine Doku Software. Die kannst du dann nach dem Programmieren über dein Programm laufen lassen. Als Ergebnis erhälst du eine Dokumentation wie die beiliegenden HTML Dateien in seinen Zip Archiven.
Gast
#491001
Super, Danke. Das ist genau das was ich brauche. (Was es nicht alles gibt...) Gruß Ignaz Antwort schreiben |
Anzeige
|
