IDE Essentials: Sourcecode Dokumentation

[charlytango]

Hallo!

Nun programmiere ich schon etliche Zeit mit Lazarus, aber mangels verfügbarer Zeit (und sicher auch an der Motivation ) kenne ich garantiert nicht einmal einen Bruchteil der Funktionen welche die IDE bietet.

Vielleicht lässt sich eine kleine Serie initiieren, die Lösungen zu bestimmten Themen aufgreift.

Meine erste Frage an die Cracks:
Wie dokumentiert ihr euen Sourcecode ?
Idealerweise so, dass man daraus automatisiert eine durchsuchbare Doku erstellen kann.

Die Foumssuche nach "Source, Doku" brachte da kein befriedigendes Ergebnis.

Ist FPDoc das Mittel der Wahl?
EDIT: nach eingem herumtesten mit FPDoc bin ich so schlau wie vorher. Bitte um Hilfe...

THX

[Mathias]

Wie dokumentiert ihr euen Sourcecode ?

Mit

Code: Alles auswählen

// {} 

mehr mache ich nicht.
Und was noch wichtig ist, ich verwende aussagekräftige Variablen und Methoden-Namen.
Somit finde ich mich auch in einem Code wieder zurecht, welcher ich vor mehreren Jahen geschrieben habe.

[af0815]

FPDoc und LAZDE für die große Doku. Kommentare für das zwischen durch.

[m.fuchs]

Wie dokumentiert ihr euren Sourcecode ?

Wenn es Quellcode ist, der als Bibliothek/Framework von anderen genutzt wird, dann benutze ich PasDoc (https://github.com/pasdoc/pasdoc/wiki) um aus den passenden Kommentaren eine schöne HTML-Doku zu machen.
Ein Beispiel dafür wäre die Synapse-Doku: http://synapse.ararat.cz/doc/help/

Bei sonstigen Quelltexten kommentiere ich möglichst nur die Stellen, die anders nicht verständlich sind. Sprich: ich schreibe nicht hin was ich mache, sondern warum. Kurze Methoden, sprechende Bezeichner sorgen dann für genügend Klarheit.