Dokumentation: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
Jeremi (Diskussion | Beiträge)
Jeremi (Diskussion | Beiträge)
Zeile 50: Zeile 50:


==== Doxygen Befehle ====
==== Doxygen Befehle ====
Wird ein Programm wie [[Doxygen]] verwendet, um aus dem Source Code automatisiert eine Dokumentation zu generieren, so können in den Kommentaren noch zusätzlich ''Special Commands''<ref>http://www.stack.nl/~dimitri/doxygen/commands.html Doxygen Manual - Special Commands</ref> verwendet werden. Mit ihnen lassen sich zum Beispiel der Text formatieren oder man kann bestimmte Meta Daten zum Code mitgeben.
Wird ein Programm wie [[Doxygen]] verwendet, um aus dem Source Code automatisiert eine Dokumentation zu generieren, so können in den Kommentaren noch zusätzlich ''Special Commands''<ref>http://www.stack.nl/~dimitri/doxygen/commands.html Doxygen Manual - Special Commands</ref> verwendet werden. Mit ihnen lassen sich zum Beispiel der Text formatieren oder man kann bestimmte Meta Informationen zum Code mitgeben.


=== Wie und was kommentieren? ===
=== Wie und was kommentieren? ===