Doxygen-Tutorial. Wer sich schon einmal in ein umfangreiches Software-Projekt einarbeiten musste, sei es zur Fehlersuche oder zwecks Änderung/Erweiterung, kann ein Lied davon singen, was es heißt ohne gute Dokumentation den Überblick über das Projekt zu bekommen.
Entwickler neigen ja gerne dazu schnell mal eine Änderung am Quellcode auszuprobieren, die bei Erfolg allenfalls irgendwo zwischen den Codezeilen mit einem knappen Kommentar dokumentiert wird und ansonsten für den Rest der Welt unbekannt bleibt. Doxygen ist ein bekanntes Open-Source-Dokumentationstool, welches an dieser Stelle ansetzt und Sourcecode automatisch dokumentieren kann. Dazu werden im Sourcecode spezielle Kommentare zu Methoden, Klassen, Variablen oder anderen Programmteilen geschrieben, aus denen Doxygen eine recht übersichtliche Dokumentation erstellt. Doxygen C++ inline template documentation.
Doxygen. All commands in the documentation start with a backslash (\) or an at-sign (@).
If you prefer you can replace all commands starting with a backslash below by their counterparts that start with an at-sign. Some commands have one or more arguments. Each argument has a certain range: If <sharp> braces are used the argument is a single word. If (round) braces are used the argument extends until the end of the line on which the command was found. If in addition to the above argument specifiers [square] brackets are used the argument is optional. Simple Doxygen templates « JustChecking's Weblog On All. This is a follow-up to previous tutorial, Simple guide to basic Doxygen usage. Here are few simple templates that you might use for documenting your source; easiest use is with e.g.
Visual Assist X, or any other tool that allows you to add predefined templates to your source code. I use these template with VAX and shortcut set to “/*!” , with short descriptive names, thus I don’t need to remember many shortcuts and have all at reach of 3 key-clicks. :D And we finish off with a small list of simple tips. How to document your code using doxygen - FLC Wiki. Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP and C#.
For details, see Here only some basic suggestions of how to document your code will be given. In order to generate doxygen based documentation, you need to follow four steps: have the doxygen executable installed on your computer (this is already done on our DESY machines) document your code create a configuration file run doxygen to create the documentation (HTML or LaTeX based). All these steps will be explained in the following. How to document your code It is highly recommended that you document your code. Note that the actual documentation consists in comments you write in the header file What you should in any case document is: who is the author of the class (Marlin processor, etc) and the last modification date what is the purpose of your class how it can be used (and/or possible caveats) what are the methods of the class good for?
Doxygen - gkw - How write code comments compatible with the doxygen parser - Gyro-kinetic simulation code for the study of turbulence in magnetised plasmas. A tool for fusion energy research. Doxygen. This chapter covers two topics: How to put comments in your code such that doxygen incorporates them in the documentation it generates.
This is further detailed in the next section.Ways to structure the contents of a comment block such that the output looks good, as explained in section Anatomy of a comment block. A special comment block is a C or C++ style comment block with some additional markings, so doxygen knows it is a piece of structured text that needs to end up in the generated documentation. The next section presents the various styles supported by doxygen. For Python, VHDL, Fortran, and Tcl code there are different commenting conventions, which can be found in sections Comment blocks in Python, Comment blocks in VHDL, Comment blocks in Fortran, and Comment blocks in Tcl respectively.
Documenting the code (using Doxygen) During an application development writing documentation is a tedious work.
In effect when you are writing the code all is clear, at this moment the code seems to document itself. But time pass, and one day you open an ancient project, look the code, ant the self documenting code now is cripted. For documenting the code I use doxygen. Using this tool I am forced to write good documentation, and "at the same price" I can get documentation in HTML format. Writing comments For documenting the code just need to use the correct syntax in the comment block, like: /** * This is the documentation */ If you use Eclipse with CDT the editor recognize you are writing documentation after the first "/**" line and automatically add "*" when you add a new line...nice. Usually the documentation of a class member can include: C++-Programmierung: Dokumentation mit Doxygen. Das von Dimitri van Heesch entwickelte Werkzeug Doxygen erstellt aus den Quelltextdateien eine übersichtliche Dokumentation der Dateien, Klassen und Funktionen eines Softwareprojekts.
Doxygen ist unter der GPL lizenziert und für die Betriebssysteme Linux, Microsoft Windows und Mac OS verfügbar. Neben C/C++ unterstützt Doxygen weitere Programmiersprachen, z.B. Java und Python. Die Ausgabe kann in den Formaten HTML, LaTeX, Unix-Manpage u.a. erfolgen. Auf der Doxygen-Homepage finden Sie eine ausführliche Anleitung, so dass wir uns hier auf die wesentlichen Aspekte beschränken können. Installation[Bearbeiten] Zusätzliche Tools[Bearbeiten]