On 5/22/07, Andries Seutens <[EMAIL PROTECTED]> wrote:
till schreef:
> Hi,
>
> was wondering what the best practise for comments inside the code is.
> I know that on classes/methods you use a Javadoc block, but what about
> inline?
>
> For example:
>
> /**
> * ...
> */
> function foo()
> {
> // Some comment here
> $bar = 'whatever';
> }
>
> Is it totally acceptable to do this ("// Some comment here"), or is
> there anything else to do instead. Or should I do a full Javadoc block
> as well?
>
> Thanks,
> Till
>
>
Inline comment should have a single star instead of. eg:
Is this a standard? On PEAR it seems to be a full docblock if you have
a multiline comment.
/*
* This is a comment on
* multiple lines
*/
Thanks,
Till
