Projekt – Tag 07

Ich habe heute den ganzen Tag damit verbracht meine bislang programmierten Klassen mit PHPDoc-konformen Kommentaren auszustatten und dann eine Dokumentation mit PHPDocumentor zu erstellen. Nach anfĂ€nglichen Problemen mit den Kommentaren bin ich jetzt ganz zufrieden mit der erstellten Doku! Siehe hier 🙂

Wenn man sich daran gewöhnt hat, dass (zumindest am Anfang) die Kommentarzeilen im VerhĂ€ltnis zu den eigentlichen Codezeilen ĂŒberwiegen, ist diese Form der Dokumentation ganz brauchbar. Vor allem kann man seinem Auftraggeber nachher eine schöne webbasierte Doku ĂŒbergeben 😉

Dann ist bloß noch die Frage, wie ich die Seiten vernĂŒnftig an meine Projektdoku anhĂ€ngen kann. Die PrĂŒfer wollen das ja sehen… Ich denke, ich werde einfach AuszĂŒge als PDF generieren und als Anhang dahinterhĂ€ngen.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind markiert *

To create code blocks or other preformatted text, indent by four spaces:

    This will be displayed in a monospaced font. The first four 
    spaces will be stripped off, but all other whitespace
    will be preserved.
    
    Markdown is turned off in code blocks:
     [This is not a link](http://example.com)

To create not a block, but an inline code span, use backticks:

Here is some inline `code`.

For more help see http://daringfireball.net/projects/markdown/syntax