Dokumentation von PHP Code

[comserver]

Hi,

ich habe mich etwas in phpDocumentor (http://www.phpdoc.org/) eingelesen und mir liegt gerade ein etwas älteres Projekt vor, dass ich gerne Dokumentieren möchte. Leider heißt das 5.000 Zeilen Code zu überarbeiten. Jetzt stellt sich mir die Frage, gibt es hierfür Tools, Parser etc. die ein Überarbeiten erleichtern ? Wie intensiv sollte man die Konventionen von phpDocumentor befolgen ? Wie wird das bei euch gehandhabt?

Gruß
Daniel

[Turbohummel]

Immer gleich beim Schreiben dokumentieren. Ich mache es inzwischen sogar so, dass ich zuerst leere Funktionblöcke hinschreibe. Also


/**
* Diese Klasse tut rein gar nix.
* @author Turbohummel
* @version 1.1
* @todo die klasse noch weniger machen lassen
*/
class Foo {

var $nix; // Ist leer
var $gar; // auch leer

/**
* Konstruktur
*/
function Foo(){

}

/**
* Die Bar tut auch nix
* @param int $leer nix
* @return boolean Nix oder Gar nix?
*/
function bar($leer){

$return (bool)$nix;
}
}

Das hilft beim Erzeugen strukturierten Codes.

In deinem Falle hilft nur Nachdokumentieren, ein Parser kann ja die Programmlogik, sprich das was das Programm macht, nicht nachvollziehen.