Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Keine Bearbeitungszusammenfassung |
|||
| Zeile 7: | Zeile 7: | ||
Gutes Kommentieren kann außerdem das Design des Programms verbessern.<ref>http://dkrukovsky.blogspot.de/2005/07/how-to-write-comments.html Make The Software Shine - How to Write Comments</ref> Wenn man nach dem [[CleanCode#Single_Responsibility_Principle_.28SRP.29|Single Responsibility Principle (SRP)]] vorgeht, so kann man den Verantwortungsbereich jeder Klasse in einem Kommentar ausdrücken. Auf diese Weise kann man stetig kontrollieren, ob die Klasse in ihrem Verantwortungsbereich operiert und das Implementieren von Aufgaben vermeiden, die nicht zu dieser Klasse gehören. | Gutes Kommentieren kann außerdem das Design des Programms verbessern.<ref>http://dkrukovsky.blogspot.de/2005/07/how-to-write-comments.html Make The Software Shine - How to Write Comments</ref> Wenn man nach dem [[CleanCode#Single_Responsibility_Principle_.28SRP.29|Single Responsibility Principle (SRP)]] vorgeht, so kann man den Verantwortungsbereich jeder Klasse in einem Kommentar ausdrücken. Auf diese Weise kann man stetig kontrollieren, ob die Klasse in ihrem Verantwortungsbereich operiert und das Implementieren von Aufgaben vermeiden, die nicht zu dieser Klasse gehören. | ||
=== Kommentare in C# und Doxygen === | === Kommentare in C# und Doxygen === | ||
| Zeile 66: | Zeile 67: | ||
==== Doxygen Befehle ==== | ==== Doxygen Befehle ==== | ||
Wird ein Programm wie [http://www.stack.nl/~dimitri/doxygen/ 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. | Wird ein Programm wie [http://www.stack.nl/~dimitri/doxygen/ 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 kommentieren? === | === Wie kommentieren? === | ||
