Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

am 05.09.2006 18:37:42 von Michael Jostmeyer

Hi zusammen,

Kennt jemand ein Tool, Script oder Eclipse-Plugin, welches zumindest die
groben Daten zu einer Funktion, Klasse usw. in einem Doku-Block
erstellt, den dann PHPDocumentor auswerten kann?
(Wenn's geht kostenlos ;-) )

Gruss Josi

Re: Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

am 05.09.2006 18:56:18 von Ulf Kadner

Michael Jostmeyer wrote:

> Kennt jemand ein Tool, Script oder Eclipse-Plugin, welches zumindest die
> groben Daten zu einer Funktion, Klasse usw. in einem Doku-Block
> erstellt, den dann PHPDocumentor auswerten kann?
> (Wenn's geht kostenlos ;-) )

Kostenlos kenn ichs nicht. Aber im Zendstudio ist das, wenn auch nur
sehr rudimentär, implementiert.

Dort läuft das zb. so:

// Baust Du function

function hasBrain($ident) {
switch ($ident) {
case 'pc': return false;
default : return true;
}
}

- Cursor über function setzen
- die Zeichen '/**' eingeben
- Enter drücken

Resultat:

/**
* ...
*
* @param unknown_type $ident
* @return unknown_type
*/

Da das Programm alle anderen Daten nicht kennen kann wars das auch
schon. Evtl. reichts Dir ja. Also ich brauch da nicht mehr.

MfG, Ulf

Re: Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

am 06.09.2006 00:20:17 von Frank Schenk

Michael Jostmeyer schrieb:
> Hi zusammen,
>
> Kennt jemand ein Tool, Script oder Eclipse-Plugin, welches zumindest die
> groben Daten zu einer Funktion, Klasse usw. in einem Doku-Block
> erstellt, den dann PHPDocumentor auswerten kann?
> (Wenn's geht kostenlos ;-) )


http://www.phpdoc.de/index.html


Frank

Re: Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

am 06.09.2006 11:01:00 von Michael Jostmeyer

Ulf Kadner schrieb:
> Kostenlos kenn ichs nicht. Aber im Zendstudio ist das, wenn auch nur
> sehr rudimentär, implementiert.
>
> Dort läuft das zb. so:
>
> // Baust Du function
>
> function hasBrain($ident) {
> switch ($ident) {
> case 'pc': return false;
> default : return true;
> }
> }
>
> - Cursor über function setzen
> - die Zeichen '/**' eingeben
> - Enter drücken
>
> Resultat:
>
> /**
> * ...
> *
> * @param unknown_type $ident
> * @return unknown_type
> */
>
> Da das Programm alle anderen Daten nicht kennen kann wars das auch
> schon. Evtl. reichts Dir ja. Also ich brauch da nicht mehr.
>
> MfG, Ulf

Ja, genau sowas meinte ich. Ich kenne das aus meiner
Entwicklungsumgebung, funktioniert dort leider nur bei
JavaScript-Funktionen...
Das Zend-Studio (5.1) hat bei mir nur Code-Completion angeboten. Aber
bin eh nicht so der Freund von Zend. Mal gucken, was die mit der
Eclipse-basierten PHP-IDE machen, da stecken die ja auch hinter.

Mal gucken, vielleicht bastel ich mir ein PHP-Skript, welches den Source
zukleistert.

Gruss Josi

Re: Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

am 06.09.2006 11:02:09 von Michael Jostmeyer

Frank Schenk schrieb:
> Michael Jostmeyer schrieb:
>> Hi zusammen,
>>
>> Kennt jemand ein Tool, Script oder Eclipse-Plugin, welches zumindest die
>> groben Daten zu einer Funktion, Klasse usw. in einem Doku-Block
>> erstellt, den dann PHPDocumentor auswerten kann?
>> (Wenn's geht kostenlos ;-) )
>
>
> http://www.phpdoc.de/index.html
>
>
> Frank
Was soll mir das sagen? Gibt es etwa Optionen, die Dokumentationen
automatisch erstellen zu lassen?

Gruss Josi

Re: Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

am 06.09.2006 21:25:32 von Frank Schenk

Michael Jostmeyer schrieb:

> Was soll mir das sagen? Gibt es etwa Optionen, die Dokumentationen
> automatisch erstellen zu lassen?

Och Josi, bissl lesen kannst doch auch oder? Vorlesen kostet extra :)

Ja, das Ding kann vollautomatisch Dokus erstellen, siehe Doku ;)


Frank

Re: Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

am 07.09.2006 10:16:04 von Michael Jostmeyer

Frank Schenk schrieb:
> Michael Jostmeyer schrieb:
>
>> Was soll mir das sagen? Gibt es etwa Optionen, die Dokumentationen
>> automatisch erstellen zu lassen?
>
> Och Josi, bissl lesen kannst doch auch oder? Vorlesen kostet extra :)
>
> Ja, das Ding kann vollautomatisch Dokus erstellen, siehe Doku ;)
>
>
> Frank
Hi Frank,

Ich glaube, entweder bin ich blind oder hab' ne Lesebehinderung oder wir
reden aneinander vorbei.
Also was ich Suche ist ein Tool, welches mir automatisch diese
Kommentarblöcke über den Klassen/Funktionen/usw. erstellt, nicht die
gerenderte Dokumentation.
Zend bietet so etwas, aber ich kann mich mit dem Zend-Studio nicht so
richtig anfreunden, nicht zuletzt wegen dem erhöhten Preis.
Der HTML/JavaScript Editor, den ich in meinem Eclipse verwende, kann so
etwas auch, allerdings nur bei den JavaScript Funktionen. Der bindet
diese Kommentarblöcke auch noch gleich richtig in die Code-Completion ein.

Gruss Josi

Re: Auto-Dokumentation von Klassen, Funktionen, Variablen usw.

am 07.09.2006 19:53:50 von Frank Schenk

Michael Jostmeyer schrieb:
> Ich glaube, entweder bin ich blind oder hab' ne Lesebehinderung oder wir
> reden aneinander vorbei.
> Also was ich Suche ist ein Tool, welches mir automatisch diese
> Kommentarblöcke über den Klassen/Funktionen/usw. erstellt, nicht die
> gerenderte Dokumentation.
> Zend bietet so etwas, aber ich kann mich mit dem Zend-Studio nicht so
> richtig anfreunden, nicht zuletzt wegen dem erhöhten Preis.
> Der HTML/JavaScript Editor, den ich in meinem Eclipse verwende, kann so
> etwas auch, allerdings nur bei den JavaScript Funktionen. Der bindet
> diese Kommentarblöcke auch noch gleich richtig in die Code-Completion ein.

Ach so, ok, wir haben aneinander vorbeigeredet :)

Kommentarblöcke über Klassen/Funktionen sind bei mir "Made by Brain
V1.0" - kostet ja eh meist nur nen Bruchteil der eigentlichen Entwicklung :)

Frank