Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Max (Diskussion | Beiträge) |
Roth (Diskussion | Beiträge) SVN weg Git da. |
||
| Zeile 120: | Zeile 120: | ||
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. | 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 | {{BA|Jeremi|Natürlich ist das nicht super streng gemeint. Beim Testen kann durchaus Code auskommentiert werden. Spätestens beim Commit ins Git sollte das aber raus}} | ||
==== Du sollst nicht Fluchen ==== | ==== Du sollst nicht Fluchen ==== | ||
| Zeile 133: | Zeile 133: | ||
Geht man etwas ungeplanter vor, so kann es passieren, dass man eine Funktion implementiert, diese aber kurze Zeit später erweitert, überarbeitet oder gar durch eine neue ersetzt. Jetzt jederzeit Kommentare zu schreiben, die man nur wenige Minuten später wieder wegschmeißt ist unnötiger Aufwand. Aus diesem Grund schiebt man das Kommentieren und somit das Dokumentieren der Funktion vor sich her. Dennoch sollte die finale Version der Funktion letztendlich kommentiert sein. | Geht man etwas ungeplanter vor, so kann es passieren, dass man eine Funktion implementiert, diese aber kurze Zeit später erweitert, überarbeitet oder gar durch eine neue ersetzt. Jetzt jederzeit Kommentare zu schreiben, die man nur wenige Minuten später wieder wegschmeißt ist unnötiger Aufwand. Aus diesem Grund schiebt man das Kommentieren und somit das Dokumentieren der Funktion vor sich her. Dennoch sollte die finale Version der Funktion letztendlich kommentiert sein. | ||
Ein guter Richtwert ist: ''Wenn man ins | Ein guter Richtwert ist: ''Wenn man ins Git committet, dann sollte alles kommentiert sein!'' (Committen sollte man sowieso nur sauberen Code.) | ||
<noinclude>== Referenzen == | <noinclude>== Referenzen == | ||
