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
IDE Essentials: Sourcecode Dokumentation
-
- Beiträge: 843
- Registriert: Sa 12. Sep 2015, 12:10
- OS, Lazarus, FPC: Laz stable (2.2.6, 3.x)
- CPU-Target: Win 32/64, Linux64
- Wohnort: Wien
IDE Essentials: Sourcecode Dokumentation
Zuletzt geändert von charlytango am So 19. Feb 2017, 18:05, insgesamt 1-mal geändert.
-
- Beiträge: 6194
- Registriert: Do 2. Jan 2014, 17:21
- OS, Lazarus, FPC: Linux (die neusten Trunk)
- CPU-Target: 64Bit
- Wohnort: Schweiz
Re: IDE Essentials: Sourcecode Dokumentation
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.
Mit Lazarus sehe ich grün
Mit Java und C/C++ sehe ich rot
Mit Java und C/C++ sehe ich rot
- af0815
- Lazarusforum e. V.
- Beiträge: 6209
- Registriert: So 7. Jan 2007, 10:20
- OS, Lazarus, FPC: FPC fixes Lazarus fixes per fpcupdeluxe (win,linux,raspi)
- CPU-Target: 32Bit (64Bit)
- Wohnort: Burgenland
- Kontaktdaten:
Re: IDE Essentials: Sourcecode Dokumentation
FPDoc und LAZDE für die große Doku. Kommentare für das zwischen durch.
Blöd kann man ruhig sein, nur zu Helfen muss man sich wissen (oder nachsehen in LazInfos/LazSnippets).
- m.fuchs
- Lazarusforum e. V.
- Beiträge: 2640
- Registriert: Fr 22. Sep 2006, 19:32
- OS, Lazarus, FPC: Winux (Lazarus 2.0.10, FPC 3.2.0)
- CPU-Target: x86, x64, arm
- Wohnort: Berlin
- Kontaktdaten:
Re: IDE Essentials: Sourcecode Dokumentation
charlytango hat geschrieben: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.
Software, Bibliotheken, Vorträge und mehr: https://www.ypa-software.de