---

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

---

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/

---

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)

---

"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