Gibt es hier Leute, die den Sourcecode mit Doxygen dokumentieren?
Wenn ja, würde ich gerne mal die Ideen/Nutzungen diskutieren. Vielleicht schafft so ein Tool ja einen Platz im zukünftigen Wiki zu kriegen.
jwka
ich fände das auch interessant.
Meine bisherige Zeit hat nur noch nicht zugelassen, dass ich mich da mal reinarbeite.
Reingearbeitet habe ich mich, habe aber halt kaum die Ergebnisse oder Meinungen reflektieren können.
Ist ja nicht selten so, dass man ne Idee/Vermutung/„Entdeckung“ hat und in der Diskussion mit anderen, evtl. schon erfahreneren Nutzern diese schnell als umständlich / hinderlich oder auf lange Sicht sogar als Quatsch herausstellen.
Daher würde ich meinen Stand im Moment auch noch nicht als „das isses“ weitergeben wollen.
Andererseits habe ich, wie ich das meist tue, einiges mitprotokolliert und vielleicht wird da so ne Art Tutorial draus. Aber erst, wenn es mit anderen reflektiert ist.
jwka
PHP-Scripte? Dafür gibts PHPDoc.
Siehe auch die kleine Diskussion hier. i.d.R. haben meine neueren Scripte auch schon die entsprechenden Tags.
Tommi
Ich habe diese Diskussion auch angesehen und überlegt, es mit PHPDoc oder Documentor zu machen.
Was mir an Doxy besser gefällt, ist, dass es auch für C und C++ sowie Python läuft.
Ferner gefällt mir besser, dass es //! als KommentarZeileenbeginn versteht, was /*–> / Auskommentierung von vielen Code-Zeilen inclusive der Kommentare ermöglicht, was m.W. bei PHPDoc nicht geht, weil dort /* --> */ die Notation ist.
Erstes ist wohl Geschmacksache, bei zweitem hat es sich für mich als echte Hürde dargestellt.
jwka
Dokumentiert wird bei mir eigentlich nur fertiger Code, da gibt es theoretisch nicht mehr viel auszukommenrtieren. Wenn doch, kommt es ganz raus, sicherheitshalber in eine eigene Datei, die man mit include zur Not wieder dazuholen kann.
Für andere Programmiersprachen muss man Fallweise entscheiden. Delphi z.B. kann mit beiden Varianten nicht umgehen. Aber andererseits: javadoc hat wieder die gleiche Syntax.
Tommi