/ 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
Argumentbeskrivelse
Fra : Jimmy


Dato : 09-09-04 13:13

Hej

Hvad er den "korrekte" måde at beskrive en funktion og dens argumenter på?

F.eks.:

function Foo ($Path, $Arr_Input, &$Bar)
{
...
return $Result
}

Det vil her være smart at angive mindst følgende:
- $Path (String) (Optional/Mandatory)
- $Arr_Input (Array) (Optional/Mandatory)
- &$Bar (String) (Optional/Mandatory) (Passed By Reference (Does/does not
always return a value)
- Returns True/False/Null/Whatever

Der er sikkert flere ting der er nødvendige for at folk efterfølgende kan få
hurtigt overblik over funktionen, men findes der ikke en accepteret og
normalt anvendt metode til at beskrive på?

Mvh
Jimmy



 
 
Ulrik Nielsen (09-09-2004)
Kommentar
Fra : Ulrik Nielsen


Dato : 09-09-04 13:18

Jimmy wrote:
> Hvad er den "korrekte" måde at beskrive en funktion og dens argumenter på?

Jeg ved ikke om den er korrekt, men det er en ret god måde:
http://pear.php.net/package/PhpDocumentor

--
ulrik nielsen |
-----------------+---------------------------------------------------
quote or the day | Increased sunspot activity.
from bofh | http://www.cs.wisc.edu/~ballard/bofh/

Peter Brodersen (09-09-2004)
Kommentar
Fra : Peter Brodersen


Dato : 09-09-04 14:09

On Thu, 9 Sep 2004 14:13:00 +0200, "Jimmy"
<nyhedsgruppe2001@SPAM.yahoo.co.uk> wrote:

>Hvad er den "korrekte" måde at beskrive en funktion og dens argumenter på?

Nogle er begejstret for phpdoc/javadoc af hensyn til automatiseringen.
Hvis det blot skal være en kort note, kan den almindelige
prototype-notation, som også bruges i dokumentationen på php.net,
bruges. Fx:

For
function Foo ($Path, $Arr_Input, &$Bar)
kunne det fx være:

bool foo ( string path [, array input [, string &bar]])

... såfremt funktionen returnerer en boolsk værdi, at første argument
er mandatory, andet er optional og tredje ligeledes er optional (uden
at være bundet til andet argument).

--
- Peter Brodersen

Ugens sprogtip: lige meget (og ikke ligemeget)

Jimmy (09-09-2004)
Kommentar
Fra : Jimmy


Dato : 09-09-04 14:21


"Peter Brodersen" <usenet@ter.dk> wrote in message
news:chpklm$5d7$1@katie.ellegaard.dk...
> On Thu, 9 Sep 2004 14:13:00 +0200, "Jimmy"
> <nyhedsgruppe2001@SPAM.yahoo.co.uk> wrote:
>
> >Hvad er den "korrekte" måde at beskrive en funktion og dens argumenter
på?
>
> Nogle er begejstret for phpdoc/javadoc af hensyn til automatiseringen.
> Hvis det blot skal være en kort note, kan den almindelige
> prototype-notation, som også bruges i dokumentationen på php.net,
> bruges. Fx:
>
> For
> function Foo ($Path, $Arr_Input, &$Bar)
> kunne det fx være:
>
> bool foo ( string path [, array input [, string &bar]])

Ser praktisk og rimeligt overskuelig ud.
Takker for svarene.

Mvh
Jimmy



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

Månedens bedste
Årets bedste
Sidste års bedste