Ergebnis der Suchanfrage

• Forum: Softwaretests und Qualitätssicherung

  AW: Was gehört alles in eine richtige Dokumentation?

   
    by r2c2, 14. Dez 2013
  Versteh nicht, was du meinst.
  
  
  Ich würde es anders sagen: Es sollte das Ziel sein, Code zu schreiben, der keines Kommentars bedarf. Allerdings ist das ein Ziel, das quasi nie vollständig zu erreichen ist.
  
  
  Ein falscher Kommentar ist schlechter als ein nicht vorhandener. Zuerst wirst du in die Irre geleitet, produzierst Bugs und verplemperst Zeit. Dann fängst du an, den Kommentaren zu...
• Forum: Softwaretests und Qualitätssicherung

  AW: Was gehört alles in eine richtige Dokumentation?

   
    by r2c2, 12. Dez 2013
  Ein gutes Tool macht dir Doku aus reinem Code ohne Kommentaren. Du schreibst also nur die Kommentare, die eien Mehrwert bieten und den Rest macht das Tool. Dadurch wird die Doku vollständig. Es mag merkwürdig aussehen, dass da "etwas fehlt". Ich fühle auch so. Aber, wenn alles, was mir einfällt, eine Paraphrase ist, die ich schreiben und andere Lesen müssen, lass ich sie lieber doch gleich weg....
• Forum: Softwaretests und Qualitätssicherung

  AW: Was gehört alles in eine richtige Dokumentation?

   
    by r2c2, 12. Dez 2013
  Das macht APIs so schwer: Wenn man sie rausgibt, bedeutet das gleichzeitig, dass man sie partiell in Zement giest. Eine API nachträglich zu ändern ist nicht mehr so einfach möglich. Aber es gibt Möglichkeiten: Schreib ne schöne, neue Methode und mach die alte deprecated. Und in 10 Jahren kannst du vielleicht drangehen, die alte zu entfernen. Das ist langwierig, ja. Aber, wenn du das jetzt nicht...
• Forum: Softwaretests und Qualitätssicherung

  AW: Was gehört alles in eine richtige Dokumentation?

   
    by r2c2, 10. Dez 2013
  - APIs sind eine Sache für sich. Da geb ich dir recht: Die Wahrscheinlichkeit, dass dort Kommentare/Doku nötig bzw. sinnvoll ist, ist um einiges höher
  - Dennoch sollten auch und gerade bei APIs die Bezeichner gut gewählt sein und die Doku im Idealfall "unnötig" machen.
  - Bei APIs sollte man auch Kleinkram, Randbedingungen, etc. dokumentieren. Denn darauf kommt es an. Ein pauschales "Mach an...
• Forum: Softwaretests und Qualitätssicherung

  AW: Was gehört alles in eine richtige Dokumentation?

   
    by r2c2, 9. Dez 2013
  Besser: Schreib deinen Code so, dass klar ist was er tut. Was eine Methode tun soll, sollte ihr Name verraten. Wenn ein Kommentar nötig ist, bedeutet das in 98,57% aller Fälle, dass entweder der Name falsch ist oder die Methode tut zu viel/das falsche und sollte aufgeteilt werden bzw. etwas anderes tun.
• Forum: Softwaretests und Qualitätssicherung

  AW: Was gehört alles in eine richtige Dokumentation?

   
    by r2c2, 18. Nov 2013
  Die Antwort auf alle Fragen in der Softwareentwicklung: "It depends" bzw. "kommt drauf an".
  
  Zu Dokumentation hat fast jeder eine Meinung. Und je nachdem, wen man fragt wird man *sehr* unterschiedliche Antworten erhalten. Fakt ist: Eine pauschale Antwort gibt es nicht.
  
  Demnach musst du die Frage für dich beantworten. Dabei solltest du folgendes bedenken:
  - Wer soll die Doku lesen? Und was...