Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Roth (Diskussion | Beiträge) SVN weg Git da. |
Vogty (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| (2 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
| Zeile 63: | Zeile 63: | ||
</source> | </source> | ||
Es können auch eigene Token erstellt werden.<ref>http://msdn.microsoft.com/en-us/library/zce12xx2(VS.80).aspx Mircrosoft msdn Library - How to: Create Task List Comments</ref> | {{BA|Vogty|Tote Referenz auf Tokens und dazugehörigen Kommentar entfernt. <!--Es können auch eigene Token erstellt werden.<ref>http://msdn.microsoft.com/en-us/library/zce12xx2(VS.80).aspx Mircrosoft msdn Library - How to: Create Task List Comments</ref>-->}} | ||
==== Doxygen Befehle ==== | ==== Doxygen Befehle ==== | ||
Wird ein Programm wie [http://www. | Wird ein Programm wie [http://www.doxygen.nl/ Doxygen] verwendet, um aus dem Source Code automatisiert eine Dokumentation zu generieren, so können in den Kommentaren noch zusätzlich [http://www.doxygen.nl/manual/commands.html Special Commands] verwendet werden. Mit ihnen lassen sich zum Beispiel der Text formatieren oder man kann bestimmte Meta-Informationen zum Code mitgeben. | ||
[[Kategorie:Code-Beispiele]] | |||
=== Wie kommentieren? === | === Wie kommentieren? === | ||
==== Innerhalb von Methoden ==== | ==== Innerhalb von Methoden ==== | ||
Nach den [[CleanCode|Clean Code Prinzip]] sollte ein Programm sich selbst beschreiben und mit möglichst wenigen Kommentaren auskommen<ref>http://www.clean-code-developer.de/Source-Code-Konventionen.ashx Clean Code Developer - Source Code Konventionen</ref> | Nach den [[CleanCode|Clean Code Prinzip]] sollte ein Programm sich selbst beschreiben und mit möglichst wenigen Kommentaren auskommen:{{BA|Vogty|Tote Referenz entfernt. <!--<ref>http://www.clean-code-developer.de/Source-Code-Konventionen.ashx Clean Code Developer - Source Code Konventionen</ref>-->}} | ||
Statt: | Statt: | ||
