Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Keine Bearbeitungszusammenfassung |
|||
| Zeile 8: | Zeile 8: | ||
Gutes Kommentieren kann außerdem das Programm-Design 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 jede Klasse mit ihrem Verantwortungsbereich mit einem Kommentar markieren. Auf diese Weise kann man stetig kontrollieren, ob die Klasse in ihrem Verantwortungsfeld operiert, und das Implementieren von Aufgaben vermeiden, wenn diese nicht zur Klasse gehören. | Gutes Kommentieren kann außerdem das Programm-Design 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 jede Klasse mit ihrem Verantwortungsbereich mit einem Kommentar markieren. Auf diese Weise kann man stetig kontrollieren, ob die Klasse in ihrem Verantwortungsfeld operiert, und das Implementieren von Aufgaben vermeiden, wenn diese nicht zur Klasse gehören. | ||
== Kommentare in C# == | == Kommentare in C# und Doxygen == | ||
C# und Visual Studio bieten verschiedene Möglichkeiten an, Kommentare zu verfassen. Neben den ''einzeiligen Kommentaren'', die nur für kurze Anmerkungen verwendet werden sollten, gibt es noch ''mehrzeilige Kommentare'' oder ''XML Kommentare'', mit denen sich der Quellcode gut dokumentieren lässt. | C# und Visual Studio bieten verschiedene Möglichkeiten an, Kommentare zu verfassen. Neben den ''einzeiligen Kommentaren'', die nur für kurze Anmerkungen verwendet werden sollten, gibt es noch ''mehrzeilige Kommentare'' oder ''XML Kommentare'', mit denen sich der Quellcode gut dokumentieren lässt. | ||
