Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Jeremi (Diskussion | Beiträge) |
Jeremi (Diskussion | Beiträge) |
||
| Zeile 2: | Zeile 2: | ||
== Warum kommentieren? == | == Warum kommentieren? == | ||
Gutes Kommentieren kann 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. | Kommentieren macht den Programmcode für andere verständlicher. Jeder Entwickler wird dankbar über hilfreiche Kommentare sein, die ein persönliches Nachfragen und somit viel Zeit ersparen. Selbst wenn man nur alleine an einem Projekt arbeitet, sollte man sich fragen, ob das auch für die Zukunft gilt. | ||
Beim schreiben einer Bibliothek, muss diese zwingend dokumentiert werden, wenn diese nur als Kompilation ausgeliefert wird. Auch in diesem Fall helfen Kommentare, da aus ihnen automatisiert eine Dokumentation erstellt werden kann. | |||
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# == | ||
