www.mikrocontroller.net

Forum: Mikrocontroller und Digitale Elektronik Was bedeuten Kommentrar wie " @name" oder "@brief"


Autor: Ignaz (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
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

Autor: Karl Heinz (kbuchegg) (Moderator)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
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.

Autor: Kai Riek (kairiek)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
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.

Autor: Ignaz (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Super, Danke.

Das ist genau das was ich brauche.
(Was es nicht alles gibt...)

Gruß Ignaz

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.
Hinweis: der ursprüngliche Beitrag ist mehr als 6 Monate alt.
Bitte hier nur auf die ursprüngliche Frage antworten,
für neue Fragen einen neuen Beitrag erstellen.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.