Dokumentations-Tools

Tomahawk

Bin mir nicht sicher, ob dies das passendste Forum für mein Anliegen ist. Derzeit dokumentiere ich meine C++ Sources so, dass sich eine einfache aber übersichtliche Dokumentation mit Doxygen erstellen lässt.

Ganz simpel:

/// \page parameters Parameters
///
/// <h1>Command-line parameters</h1>
/// <ul>
/// <li> -c [ --config ] arg Sets the name of the configuration file.
/// <li> -h [ --help ] Prints this help message.
/// </ul>

oder

/// Returns an application info.
extern std::string ApplicationInfo();

Welche Tools sind noch empfehlenswert bzw. werden zB von Google (Chromium-Projekt) eingesetzt? Habe bisher noch folgendes finden können:

http://www.naturaldocs.org/

Danke und Gruß,
T.

C++ Forumbot

Dieser Thread wurde von Moderator/in SeppJ aus dem Forum C++ (auch C++0x und C++11) in das Forum Rund um die Programmierung verschoben.

Im Zweifelsfall bitte auch folgende Hinweise beachten:
C/C++ Forum :: FAQ - Sonstiges :: Wohin mit meiner Frage?

Dieses Posting wurde automatisch erzeugt.

... Java da hast du schönes JavaDoc!

Bleistift und Papier tuts auch

Vertexwahn

Alternativen zu Doxygen sind DOC++, NaturalDocs
siehe auch: http://stackoverflow.com/questions/2323074/doxygen-alternative-for-c

Ansonsten könntest du auch selber ein Dokumentationssystem programmiern:
http://bitsquid.blogspot.de/2011/09/simple-roll-your-own-documentation.html

Doxygen ist meiner Meinung nach schon eine sehr gute Dokumentationslösung für C++ Sourcecode und habe ich auch schon bei verschiedenen Firmen im Einsatz gesehen

BTW: Man sollte auf verschiedenen Abstraktionsebenen dokumentieren
- Kommentar direkt im Code, im speziellen Kommentare die nicht von Doxygen erfasst werden
- Dokumentation, die direkt aus Quelltext generiert wird
...
- Übersicht über das Projekt als UML Package Diagram
...

+---------------------------------+------------------------------------+ | hoch 
|  Benutzerdokumentation          |      Entwicklerdokumentation       | |
|                                 | (Pflichtenheft, Zeitplan, usw.)    | |
|                                 |      Generierte Dokumentation      | |
|                                 |    Kommentare im Quelltext         | |  Abstraktion
+---------------------------------+------------------------------------+ |
|    Anwendersicht                |          Entwicklersicht           + |
+---------------------------------+------------------------------------+ v niedrig

Doxygen bietet Möglichkeiten jedes Abstraktionniveau zu erfassen - jedoch eignet es sich für generierte Dokumentation am besten