[PHP] Code Dokumentation Netbeans 6.5

[SatansEier]

Hallo,

in nem halben Jahr steht meine Projektprüfung zum FI/AE an.

Jetzt frag ich mich, während ich so über dem Antrag sitze, wie ich später meine Code-Dokumantation hinbekomm. Im Visual Studio lässt sich ja bequem aus Kommentaren mit bestimmten tags eine Doku generieren.

In Netbeans gibt sowas auch, allerderdings nur für die IDE-interne Doku.

/**

* @...

*/[/PHP]

Kennt jemand ein Plugin oder nen Workaround für Windows?

Hatte vllt selbst jemand eine PHP-Applikation als Thema in seiner Projektprüfung und kann mir sagen wie ers aufgezogen hat?

Besten Dank vorab:)

[Aiun]

*kopfkratz*

Was hat deine Code-Dokumentation mit deiner Prüfung am Hut ?

die FI-AE Prüfung geht normalerweise eher auf Methodik als auf Code. Ok, du gibst den Code mit ab, aber was willst du noch ? ... volle API-Klassendokumentation abgeben ? .. wer soll die lesen ? ^^

Es gibt für PHP mehrere Auto-Dokumentiere die eben diese meta-Tags auswerten (@author @param, @return ...)

das was du da beschreibst ist kein IDE-Ding von Netbeans sondern Doku nach Standard..... das machen alle größeren IDE's so ^^

/**

* @autor

* @param myparam mydesc

* @unsw. andere

*/

[SatansEier]

Und für die Methodik gilt als Vorlage UML?

[Aiun]

in nem halben Jahr steht meine Projektprüfung zum FI/AE an.

dann solltest du diese Frage nicht mehr stellen ^^

Methodik heist "vorgehen", "art des vorgehens", "arbeitsweise". Geprüft wird meist wie du arbeiten kannst, Projektmanagement, Planung und das ganze. Natürlich schaut auch mal jemand in den Code, aber eher nebensächlich.

[Aiun]

also nicht denken das ich dich hier entmutigen will...

aber du solltest dir nochmal informationen darüber ansehen wie die Prüfung ab läuft und worauf die Prüfer bei euch achten.

Ich habe Inline-Code-Dokumentation verwendet (also das mit den @s das ich oben angedeutet habe) und dann die übliche Projektdokumentation.

[SatansEier]

Das ist heute der erste Tag an dem ich mich damit richtig beschäftige.

Hatte selbst nur die Schwerpunktverteilung anders eingeschätzt.

Jetzt hast du ja auch schon angedeutet wie in etwa die themabezogenen Fragen aussehen könnten.

[SatansEier]

Zur Code-Dokumentation.

Externe Programme, mit denen ich mir vorstellen könnte den Code zu dokumentieren wären:

- phpDocumentor

- PHP-JavaDoc (+)

Kennt vllt noch zusätzlich jemand ein Plugin für Netbeans 6.5?