Was nehmt ihr zum Dokumentieren von Quellcode?

HeyProggy,

Also ich verwende nun seit einiger Zeit das OpenSource- Tool Doxygen.
Es bietet meiner Meinung nach viele Funktionen, die du selbst in kommerziellen Anwendungen nicht findest.

Das tolle daran ist, dass du dieses Dokumentationssystem für alle beliebigen Programmiersprachen (zumindest für die wichtigsten) nutzen kannst und das sogar unter Windows, Linux und MacOS.

Ich hab auch eine tolle Einführung zu diesem Thema gefunden, die dir meiner Meinung nach den Einstieg sicherhlich sehr erleichtern wird ... ich empfehle dir auch die PDF- Datei auf der Seite mal runterzuladen und gegebenenfalls auszudrucken, wenn du was nachschlagen willst!!!

Der Link ist:
http://www.netzwerkdeswissens.de/ArtikelZusammenstellen_DB.php?artikel_id=29

Ich denke mit dem Tool bist du echt gut bedient. Ich setze es professionell ein und bescäftige mich hauptsächlich mit C#, C++ und Java (dein PHP wird auch unterstützt). Die Dokmentationsqualität ist meiner Meinung nach Höher als mit Standardtools wie Javadoc!!!

Viel Spaß damit

Jep, Doxygen hätte ich jetzt auch empfohlen. Ist ähnlich wie Javadoc (von der Verwendung/Ergebnis her), bietet aber noch einige zusätzliche Möglichkeiten und ist für viele Sprachen verfügbar.

Also ich verwende für meine C++ Projekt nichts anderes als Doxygen ... kann dir das also auch nur empfehlen, so wie meine Vorredner

Wir haben in unserer Firma früher "Natural Docs" eingesetzt, da es auch sehr viele Programmiersprachen unterstützt und einfach zu handhaben ist.

Ich kann dir das auch nur empfehlen, kannst dir ja mal ein Beispiel einer Dokumentation auf der offiziellen Seite dazu anschauen:
http://www.naturaldocs.org/documentation/html/files/NaturalDocs-.html

Aufgrund der übersichtlicheren und meiner Meinung nach besseren Dokumentationsqualität (Hervorhebung durch Farben, rtc.) sind wir vor kurzem allerdings auch auf Doxygen umgestiegen (http://www.doxygen.org).
Ich habe mal in die oben empfohlene Einführung reingeschaut, mir ist aufgefallen, dass sie auf der offiziellen Doxygenseite ebenfalls verlinkt ist (http://www.stack.nl/~dimitri/doxygen/articles.html ). Ich denke für den Einstieg kann dir das echt weiterhelfen ... und ich glaube aufgrund meiner Berufserfahrung kann ich das ein wenig beurteilen.

Viel Erfolg bei deinem weiteren Trieben