Blafasel bloggt

Wo die Macht geistlos ist, ist der Geist machtlos

Dokumentation

| 22 Kommentare

Wir Entwickler tun uns in der Regel ja schwer mit der Dokumentation unseres Quellcodes.
Ein Kollege hat heute eine entsprechende Begründung dafür geliefert, dass man seine Sourcen undokumentiert lassen kann:

Guter Code braucht keine Dokumentation!
Schlechter Code ist es nicht wert Dokumentiert zu werden!

22 Kommentare

  1. Zitat:“Guter Code braucht keine Dokumentation!“

  2. Zitat: „Guter Code braucht keine Dokumentation!“

    HURRA! genau solchem Denken haben Firmen die bestehenden Code übernehmen einen Refactoring-Aufwand, der einen Investitionsschutz bestehenden Codes unmöglich macht. Einarbeitung neuer Mitarbeiter an Hausinternen Code, macht dann auch richtig Spass! Entwickler die den Code geschrieben haben, sollten ja jeder Zeit zur Verfügung stehen um neuen Mitarbeitern Ihre Gedankengänge des Codes den Sie geschrieben haben zu erklären(jaa, auch dabei hilft Code-Dokumentation). Nur schade das Entwickler auch ab und zu den Arbeitgeber wechseln. Dann sieht es schon mal Schei.. aus mit der Erklärung.

    Meine Antwort darauf: Teamgeist ist das was guten Code ausmacht!

  3. hehe genau so ist dass!!! Wer Proggen kann der brauch keine Comments im Code!!

  4. It was hard to code – it should be hard to understand.

  5. Ich würde eher sagen, schlecht dokumentierter Code ist schlechter Code.

  6. Also Deine Wortspiele finde ich genial.

    Die machen allein Deine Seite lesenswert.

    Sowohl Macht und Geist als auch diese Überschrift sind einfach Klasse.

    Mach weiter so, ich komme wieder
    und möge der Quellcode mit Dir sein

  7. Oh ja, die Doku… die Sprüche werde ich mir aber aufschreiben und dann am Anfang jeder Datei einbinden 🙂

  8. Doku ist nur für andere 😉

  9. wo er Recht hat…

  10. Sprechende DEUTSCHE Variablen und ein kurzes Hinweis WARUM etwas erreicht werden soll hilft wunder.

    Ala:
    1. Es soll eine Schnittstelle aus der Definition xy eingelesen werden in die Tabellen xy welche hier und dort angezeigt werden
    2. Verarbeite die Einzulesenden Daten
    3. Übergebe die Daten und prüfe auf Gültigkeit

    Es bringt einem GUT GESCHRIEBENER Code allein wenig, wenn man nicht weiß WARUM etwas geschrieben wurde. Beides bringt etwas. Allerdings muss ich hier auch einmal monieren, dass man sich auch Kaputtdokumentieren bzw. überflüssig Kommentieren kann.
    Wie schon richtig gesagt : ich brauche nicht schreiben WAS ich mache, denn das sollte jeder Programmierer lesen können.

    Ergo : Überlegen bei der DOKUMENTATION WARUM man etwas macht wie man es macht und nicht WAS man gerade macht.

    als Test dazu finde ich es immer schön, wenn man sich seinen eigenen CODE nochmal nach 2 Jahren anschaut. Wenn man versteht wozu man es gebraucht hat, dann ist man schon auf dem richtigen Pfad der erleuchteten.

  11. Hier mal ein Beispiel für Überflüssige unnötige Dokumentation aus diesem Blog :

    Zitat :

    Beispiel für MatchCollection

    //Neues Objekt erzeugen
    Regex r = new Regex(„abc“);
    //Ein Match suchen
    MatchCollection mc = r.Matches(„123abc456abcd“);
    //Wenn ein Match gefunden wurde, dann Details ausgeben
    for (int i=0; i

  12. Richtig sollte es vielmehr lauten :

    Beispiel für MatchCollection

    //1. Suche Treffer innerhalb eines Strings
    //2. Gebe Trefferdateils (Position+Trefferstring) zurück

    //Ausgabe sollte lauten :
    //Treffer an Position: 3
    //Gefunden wurde: abc
    //Treffer an Position: 9
    //Gefunden wurde: abc

    //1. Suche Treffer innerhalb eines Strings
    Regex lcZusuchenderstring = new Regex(„abc“);
    MatchCollection loGefundenestellen = lcZusuchenderstring.Matches(„123abc456abcd“);

    //2. Gebe Trefferdateils (Position+Trefferstring) zurück
    for (int i=0; i

  13. Wahrheit bleibt immer Wahrheit;-)

  14. Sehe dieses genauso, warum ist es so schwer umzusetzen??;-)))

  15. Wo die Macht geistlos ist, ist der Geist machtlos. Gute Weisheit, trifft genau auf viele „DOKUMENTATION“ zu, deshalb muss ich euch auf ganzer Linie recht geben.

  16. Wo der Kollege Recht hat – hat er nun mal Recht…

  17. Hier herscht ja eine rege Diskussion 😉

    Finde den Blog sehr interessant und dieser ist soeben in meinen Feedreader geflogen.

    Weiter so!

    Grüße, Chris

  18. Na ja, wäre der Spruch ernst gemeint, wäre er zweifellos geistlos. Ist sicher nur eine Provokation oder doch eine ernstgemeinte Meinung eines Programmierers, der lange kein Sonnenlicht mehr sah. Klar verstehe ich meinen code selbst, wenn ich ihn selbst geschrieben habe, aber was ist mit den Kollegen? Dieses arrogante Gesabbel „guter code muss nicht dokumentiert werden“ ist ausgemachter Unsinn bzw. nur für Einzelkämpfer geeignet.

  19. Hallo,

    ich finde den Spruch auch nicht so toll. Das Blog mag ich aber, ganz dolle 🙂

    Grüße

    Gretus

  20. Hmm wenn ich mir manchmal meinen Code anguck wüsste ich ohne comments nach einem halben Jahr nicht mehr worum es geht, aber das ist bei Kollegen das gleiche *g*. Ansonsten guter Blog, weiter so.

  21. Also ich baue nur bei ganz schwierigen stellen comments ein, sonst kostet das zu viel Zeit 😉

  22. wer proggen kann ist klar im vorteil. die comments sind nur was für anfänger. gruß

Schreibe einen Kommentar

Pflichtfelder sind mit * markiert.