-- Thomas Weidner <[EMAIL PROTECTED]> wrote
(on Thursday, 04 January 2007, 09:27 AM +0100):
> >I do like the visual separation achieved by the hyphen in the PHP source 
> >code, but am not attached to any particular way of accomplishing such 
> >separation.  I read code, and rarely ever bother reading the extracted 
> >phpdoc summary, as I usually want to also see the function's definition.
> >
> >Any ideas on alternative ways to accomplish the visual separation of 
> >parameter descriptions without using a hyphen?
> 
> Erase only the hypen...
> 
> * @param bool $param2      OPTIONAL Description goes here (default: false)
> * @param string|array $flags A flag or array of flags.
> 
> But let the whitespaces to the description of the parameter.
> So all parameter descriptions are at the same intention.
> So phpdoc should work correct, and the pure API doc is also more readable

I should have said that in my original email, but that was my intention.
Phpdoc strips the whitespace when creating the documentation, so you get
the best of both worlds in that regards -- visual separation in the
source, and API docs without extraneous characters.

-- 
Matthew Weier O'Phinney
PHP Developer            | [EMAIL PROTECTED]
Zend - The PHP Company   | http://www.zend.com/

Reply via email to