Was gehört alles in eine richtige Dokumentation?

[Furtbichler]

Zitat von r2c2:

Ein gutes Tool macht dir Doku aus reinem Code ohne Kommentaren.

Das bezweifle ich, das es ein Tool gibt, das mir eine Routine dokumentiert, ohne das ich Kommentare schreibe. Was so ein Tool macht, ist den Methodennamen und die Parameter + Typen in ein Template zu klatschen und -ja- die von mir geschriebenen Kommentare da irgendwie reinzupflastern. Altbekannt und banal.

Was ich meine, ist die Frage, ob selbsterklärende API-Funktionen eines redundanten Kommentares bedarf. Wir hatten das Thema lustigerweise heute im Team und als ich anmerkte: "Ja 'CreateForm' mit 'Creates a Form' zu dokumentieren, ist heute blödsinnig, aber Kommentare leben und ein existierender Kommentar wird eher erweitert, als ein nicht vorhandener" Die Argumentation stieß auf Zustimmung