Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
| Zeile 4: | Zeile 4: | ||
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. | 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 | Beim Schreiben einer Bibliothek muss diese zwingend dokumentiert werden, da Benutzer der Bibliothek deren Quellcode meistens nicht lesen möchten. Auch in diesem Fall helfen Kommentare, da aus ihnen automatisiert eine Dokumentation erstellt werden kann. | ||
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 === | ||
