Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Jeremi (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Jeremi (Diskussion | Beiträge) |
||
| Zeile 69: | Zeile 69: | ||
== Wie man NICHT kommentieren sollte == | == Wie man NICHT kommentieren sollte == | ||
... | Manchmal ist es einfach leichter zu sagen, wie man es eben nicht machen sollte<ref>http://allthingsoracle.com/how-to-make-comments-the-most-important-code-you-write/ How to make comments the most important 'code' you write</ref>: | ||
=== Unterschätze die Zielgruppe nicht === | |||
Wer auch immer in den Code reinschauen wird, es wird sicherlich auch ein Entwickler (aus deinem Team?) sein. Solche Kommentare sind völlig unnötig und gehören raus: | |||
<source lang="csharp"> | |||
ACHTUNG NEGATIVBEISPIEL! | |||
//Initialisiere i mit 20 | |||
int i = 20; | |||
</source> | |||
=== Übertreibe es nicht === | |||
Wenn man aufgrund lauter Kommentare den Code selbst plötzlich suchen muss, dann wurde inzwischen bei weitem viel zu viel kommentiert. Innerhalb von Prozeduren sollten nur dann Kommentare verwendet werden, wenn es aus dem Code selbst nicht ersichtlich ist, was er tut (Clean Code Ansatz). | |||
=== Trenne dich von altem Code === | |||
Lösche nicht mehr gebrauchten Code, anstatt ihn auszukommentieren. Ansonsten sammeln sich nach und nach im Quellcode immer mehr Codeleichen an, die völlig unnötig sind. | |||
{{BA|Jeremi|Natürlich ist das nicht super streng gemeint. Beim Testen kann durchaus Code auskommentiert werden. Spätestens beim Commit ins SVN sollte das aber raus}} | |||
=== Du sollst nicht Fluchen === | |||
Selbst wenn dich gerade ein Stück Code in Rage versetzt, solltest du dich beim Schreiben eines Kommentars zurückhalten. Es ist gesünder für die Zusammenarbeit im Team und kann dich im Berufsleben im schlimmsten Fall den Job kosten. [[Kategorie:Code-Beispiele]] | |||
== Wann kommentieren? == | == Wann kommentieren? == | ||
