Einzelnen Beitrag anzeigen

redox
(Gast)

n/a Beiträge
 
#11

AW: Eure favorisierte Form der Dokumentation

  Alt 12. Jul 2015, 08:57
Das funktioniert nicht. Also eine externe Dokumentation. Da könne mir die Theoretiker noch so viel erzählen. Wer sucht im Wiki schon nach Antworten, wenn er den Quellcode vor sich im Editor offen hat? Und eine externe Doku hängt dem aktuellen Stand immer hinterher. Und ich habe noch keinen Kollegen getroffen, der die externe Doku pflegt. Besser aussagekräftiger Code mit sparsamen Kommentaren warum so und nicht anders.
Jupp.

Benutzerhilfe mit http://www.helpndoc.com/de

Ansonsten RTF-Dateien (ohne Bilder, die mit WordPad angezeigt werden können) oder PDFs mit LibreOffice.


Eventuell problematische Quelltextzeilen kommmentiere ich immer mit
...// Depp
// Depp weil es mit i < 0 abschmiert, daher i := abs(i)

https://de.wikipedia.org/wiki/Depp

  Mit Zitat antworten Zitat