Re: convention for documenting function parameters in doc strings

2010-02-09 Thread danielx
On Feb 8, 2:49 am, Jean-Michel Pichavant wrote: > danielx wrote: > > Is there aconventionfor how to document function (or method) > > parameters in doc strings? Recently, I've been doing alot of PHP > > programming, and in PHPdoc, you'd do it like this: > > > /* > >  * @param type $foo Description

Re: convention for documenting function parameters in doc strings

2010-02-08 Thread Jean-Michel Pichavant
danielx wrote: Is there a convention for how to document function (or method) parameters in doc strings? Recently, I've been doing alot of PHP programming, and in PHPdoc, you'd do it like this: /* * @param type $foo Description. * * @return type Description. */ function bar($foo) { ... }

convention for documenting function parameters in doc strings

2010-02-07 Thread danielx
Is there a convention for how to document function (or method) parameters in doc strings? Recently, I've been doing alot of PHP programming, and in PHPdoc, you'd do it like this: /* * @param type $foo Description. * * @return type Description. */ function bar($foo) { ... } Is there an equiv