IT-weblog

All der tägliche Frust und Schweiß der IT-Branche

Fleißarbeit Doku-Soap

Lieblingsbeschäftigung eines Programmierers? Inline Source Dokumentation schreiben!

Da nimmt man doch schon selbsterklärende Variablennamen wie i und dann auch noch alle Dateien, Methoden und Klassen durchdokumentieren. Ist ja schon in Ordnung, wenn man es gleich miterfasst. Aber frage mich keiner rückwirkend nach dem einen oder anderen Trick im Code.

Blöd wirds nur, wenn das ganze leider nur wegen den Vertragsklauseln geschrieben, aber niemals gelesen werden wird. All der Prosa-Schweiß umsonst? Schade drum.

3 Kommentare

  1. Als ich neulich ein eigenes / privates Projekt angefangen habe zu Dokumentieren ist mir eins aufgefallen… wenigstens weiß man hinterher selbst genau was man gemacht hat und was man am besten in Version +1 hinzufügen sollte. Daher: Doku für den Fortschritt.

  2. Doku für den Fortschritt, das gefällt mir!

    Setz natürlich voraus, daß das Projekt eine Phase 2 überleben wird. Bei kürzeren Aktionen wir Umfragen usw. ist das leider nicht immer der Fall. Das bremst natürlich auch die Dokumentationsintensität.

  3. Auch immer wieder schön sind Doku Stilblüten in anderen Programmen:

    Beispiel:

    /*Warum nächster Schritt, weiss ich nicht mehr ist wahrscheinlich redundant. Würde ich aber drin lassen */

    Sehr beruhigend…

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.

*

© 2017 IT-weblog

Theme von Anders NorénHoch ↑