/ Forside / Teknologi / Udvikling / PHP / Nyhedsindlæg
Login
Glemt dit kodeord?
Brugernavn

Kodeord


Reklame
Top 10 brugere
PHP
#NavnPoint
rfh 3959
natmaden 3372
poul_from 3310
funbreak 2700
stone47 2230
Jin2k 1960
Angband 1743
Bjerner 1249
refi 1185
10  Interkril.. 1146
PHPdoc
Fra : Jacob Bunk Nielsen


Dato : 09-08-01 09:43

Hej

Jeg skal have dokumenteret noget PHP-kode. Jeg har i den anledning set
på PHPdoc fra <http://www.phpdoc.de/>, som langt hen ad vejen klarer
mit problem, og som ser godt ud for en gammel Java-programmør som mig.

Det mangler dog et par ting i forhold til det rigtige Javadoc
Jeg er glad for at det kører som rent PHP, da det så kan køre på alle
de webservere, hvor vi måtte have kode liggende.

Hvad bruger I andre når I er flere om at kode noget, og skal have det
dokumenteret, så andre kan finde rundt i det senere?

Jacob

 
 
Niels Andersen (09-08-2001)
Kommentar
Fra : Niels Andersen


Dato : 09-08-01 09:43

"Jacob Bunk Nielsen" <jacob@ntvcom.dk> wrote in message
news:u3d71pqs8.fsf@ntvcom.dk...
> Hvad bruger I andre når I er flere om at kode noget, og skal have det
> dokumenteret, så andre kan finde rundt i det senere?

Puha, det var dog utroligt tæt på hvad jeg har tænkt over for ikke så lang
tid siden. :)

Jeg kom frem til, at der findes nogle systemer der har nogle glimrende
koncepter. De to bedste hed vist begge PHPdoc, hvor du har fundet den ene.
Den anden læste php'en igennem og ændrede syntaxen en anelse, og brugte så
den javadoc til at lave dokumentationen.

Men jeg fandt intet som er brugbart nu, og i hvert fald ikke til mit behov.

I øjeblikket består min dokumentation dels af at skrive kode, der er let at
forstå, dels ved at skrive en masse kommentarer.
Der udover er jeg ved at lave et lille lokalt "code library" (noget
PEAR-agtigt), hvor hver enkelt fil er en klasse eller en funktion, hvor
"kontrakten" (som det hedder i Java) er grundigt dokumenteret.


Mvh.

Niels Andersen



Jacob Bunk Nielsen (09-08-2001)
Kommentar
Fra : Jacob Bunk Nielsen


Dato : 09-08-01 10:06

"Niels Andersen" <niels-usenet@myplace.dk> writes:

> Puha, det var dog utroligt tæt på hvad jeg har tænkt over for ikke så lang
> tid siden. :)

Sådan kan det jo gå

> Jeg kom frem til, at der findes nogle systemer der har nogle glimrende
> koncepter. De to bedste hed vist begge PHPdoc, hvor du har fundet den ene.
> Den anden læste php'en igennem og ændrede syntaxen en anelse, og brugte så
> den javadoc til at lave dokumentationen.

Jeg bryder mig ikke om noget der piller i syntaksen for koden, da det
ofte vil komme på tale at lave rettelser i det senere her.

> Men jeg fandt intet som er brugbart nu, og i hvert fald ikke til mit behov.

Øv
Jeg er som sagt gammel Java-programmør, og er enormt glad for Javas
dokumentation. Den PHPdoc jeg har testet er tæt på at lave noget jeg
kan bruge, men det ser ikke ud som om der er sket noget med det det
sidste halve år. Man kan jo håbe at der snart sker noget igen.

Det ville også være fedt med noget der lige kan finde versionsnumre ud
fra CVS.

Måske man skulle overveje at lave nogle udvidelser til den PHPdoc der
findes på <http://www.phpdoc.de/>.

> I øjeblikket består min dokumentation dels af at skrive kode, der er let at
> forstå, dels ved at skrive en masse kommentarer.

Det er netop det med at kigge i koden vi gerne vil undgå, da det tager
markant længere tid at kigge i koden end at læse en kort præcis
dokumentation i et standardiseret format.

.... og så har jeg som Java-programmør som sagt også en svaghed for
Javadoc.

> Der udover er jeg ved at lave et lille lokalt "code library" (noget
> PEAR-agtigt), hvor hver enkelt fil er en klasse eller en funktion, hvor
> "kontrakten" (som det hedder i Java) er grundigt dokumenteret.

Men du har ikke planer om at kaste noget PHPdoc eller lignende efter
det?

Jacob

Niels Andersen (09-08-2001)
Kommentar
Fra : Niels Andersen


Dato : 09-08-01 10:36

"Jacob Bunk Nielsen" <jacob@ntvcom.dk> wrote in message
news:uy9otob68.fsf@ntvcom.dk...
> > Den anden læste php'en igennem og ændrede syntaxen en anelse, og brugte

> > den javadoc til at lave dokumentationen.
> Jeg bryder mig ikke om noget der piller i syntaksen for koden, da det
> ofte vil komme på tale at lave rettelser i det senere her.

Bare rolig, den ændrer ikke i dine filer. :)
Den laver lidt om på syntaxen så det godt nok ikke længere er gyldigt PHP,
men det er noget javadoc forstår. Det bliver så gemt i en midlertidig fil.

> Det er netop det med at kigge i koden vi gerne vil undgå, da det tager
> markant længere tid at kigge i koden end at læse en kort præcis
> dokumentation i et standardiseret format.

Lige præcis. Men det eneste jeg gør nu, er at gøre det helt manuelt - skrive
et dokument! :)

> ... og så har jeg som Java-programmør som sagt også en svaghed for
> Javadoc.

Ja, den virker også meget smart, i et "100%" oo-sprog. Men det ser ud til at
der er lidt problemer med at overføre princippet til PHP.
I PHP er det jo altså ikke ALLE opgaver der er smarte at løse med klasser.
:)

> > Der udover er jeg ved at lave et lille lokalt "code library" (noget
> > PEAR-agtigt), hvor hver enkelt fil er en klasse eller en funktion, hvor
> > "kontrakten" (som det hedder i Java) er grundigt dokumenteret.
>
> Men du har ikke planer om at kaste noget PHPdoc eller lignende efter
> det?

Jeg har tænkt på at udforme kommentarer og dokumentation så der kan kastes
NOGET efter det senere. Men når man ikke aner hvordan syntaxen skal være,
kan det vist være det samme. :)


Mvh.

Niels Andersen



Jacob Bunk Nielsen (09-08-2001)
Kommentar
Fra : Jacob Bunk Nielsen


Dato : 09-08-01 11:15

"Niels Andersen" <niels-usenet@myplace.dk> writes:

> > Jeg bryder mig ikke om noget der piller i syntaksen for koden, da det
> > ofte vil komme på tale at lave rettelser i det senere her.
>
> Bare rolig, den ændrer ikke i dine filer. :)

OK, det var sådan jeg lige forstod det.

> Den laver lidt om på syntaxen så det godt nok ikke længere er gyldigt PHP,
> men det er noget javadoc forstår. Det bliver så gemt i en midlertidig fil.

Se, det lyder straks bedre. Eneste problem er så bare at javadoc skal
findes på serveren.
Som sagt har vi kode liggende forskellige steder, og dermed er det en
fordel at der ikke skal være nogle særlige krav til serveren, altså at
det som PHPdoc fra <http://www.phpdoc.de/> kører i rent PHP.

> Lige præcis. Men det eneste jeg gør nu, er at gøre det helt manuelt - skrive
> et dokument! :)

Det har vi slet ikke lyst til. Det har vi faktisk heller ikke tid til


> > ... og så har jeg som Java-programmør som sagt også en svaghed for
> > Javadoc.
>
> Ja, den virker også meget smart, i et "100%" oo-sprog. Men det ser ud til at
> der er lidt problemer med at overføre princippet til PHP.

Ja, OOP i PHP er jo desværre ikke alt hvad man kunne have håbet på
Men en hel del af det vi laver kan laves OO.

> I PHP er det jo altså ikke ALLE opgaver der er smarte at løse med klasser.
> :)

Nej, men en ganske stor del af vores "standard" kodebase kan laves på
den måde, og dermed giver det mening.

> Jeg har tænkt på at udforme kommentarer og dokumentation så der kan kastes
> NOGET efter det senere. Men når man ikke aner hvordan syntaxen skal være,
> kan det vist være det samme. :)

Hvis du holder dig til en standard kan man vel altid lave noget til at
omforme det til en ny standard.

Jacob

Emil Rasmussen (09-08-2001)
Kommentar
Fra : Emil Rasmussen


Dato : 09-08-01 12:44

Hejsa
>
> Måske man skulle overveje at lave nogle udvidelser til den PHPdoc der
> findes på <http://www.phpdoc.de/>.
>

Der findes en phpdoc look-a-like der ser ud til at være mere gang i her:
<http://phpdocu.sourceforge.net>.

Mvh Emil

--
Emil Rasmussen
http://noget.net




Jacob Bunk Nielsen (09-08-2001)
Kommentar
Fra : Jacob Bunk Nielsen


Dato : 09-08-01 15:23

"Emil Rasmussen" <4833o41fj001@sneakemail.com> writes:

> Der findes en phpdoc look-a-like der ser ud til at være mere gang i her:
> <http://phpdocu.sourceforge.net>.

Jeg kan ikke huske hvorfor jeg i første omgang sprang den over da jeg
kiggede omkring, for jeg er helt sikker på at jeg så den.

Nu har jeg så lige testet den. Det eksempel der ligger på
<http://phpdocu.sourceforge.net/peardocs/> ser jo godt nok ud, men jeg
kan altså ikke få den til at lave noget som helst andet end en flok
næsten indholdsløse html-filer.

--
Jacob
This sentence is false.

http://www.bunk.cc - nu med Emacs effekt

Emil Rasmussen (10-08-2001)
Kommentar
Fra : Emil Rasmussen


Dato : 10-08-01 08:50


> Nu har jeg så lige testet den. Det eksempel der ligger på
> <http://phpdocu.sourceforge.net/peardocs/> ser jo godt nok ud, men jeg
> kan altså ikke få den til at lave noget som helst andet end en flok
> næsten indholdsløse html-filer.

En ting som jeg overså først var, at man skulle lave to ** altså /**. Det
var i hvert fald noget der drillede mig

Men ellers er der en lille howto på websitet.

Mvh Emil

--
Emil Rasmussen
http://noget.net




Jacob Bunk Nielsen (11-08-2001)
Kommentar
Fra : Jacob Bunk Nielsen


Dato : 11-08-01 13:08

"Emil Rasmussen" <4833o41fj001@sneakemail.com> writes:

> En ting som jeg overså først var, at man skulle lave to ** altså /**. Det
> var i hvert fald noget der drillede mig

Det er ikke det der driller mig. PHPdoc fra <http://www.phpdoc.de>
virker fint, så der må være noget andet.

> Men ellers er der en lille howto på websitet.

Det kan være jeg skal kigge lidt på den.
Så håber jeg bare at den har lidt flere af de frække detaljer fra
javadoc med end hvad jeg ellers har set indtil nu.

--
Jacob
On the Internet, no one knows you're using Windows NT.

http://www.bunk.cc - nu med Emacs effekt

Søg
Reklame
Statistik
Spørgsmål : 177552
Tips : 31968
Nyheder : 719565
Indlæg : 6408849
Brugere : 218887

Månedens bedste
Årets bedste
Sidste års bedste