Home > Archive > PHP PEAR Questions and Answers > January 2008 > Re: [PEAR-QA] Docblock alignment standards
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Re: [PEAR-QA] Docblock alignment standards
|
|
| Chuck Burgess 2008-01-12, 7:05 pm |
| On Jan 12, 2008 7:02 AM, Greg Sherwood <gsherwood@squiz.net> wrote:
> if any asterisk in a docblock is followed by more than once space.
>
I know there are times when I use additional spacing after the leading
asterisk specifically for visual formatting, in particular when inside
<code> tags, <pre> tags, and simple lists. See the "DocBlock Description
Details" section of the PhpDocumentor manual for examples (
http://pear.php.net/package/PhpDocu...tml#basics.desc
).
Will this new restriction apply in these cases?
--
CRB
| |
| Greg Sherwood 2008-01-12, 7:05 pm |
|
Chuck Burgess wrote:
> On Jan 12, 2008 7:02 AM, Greg Sherwood <gsherwood@squiz.net> wrote:
>
>
> I know there are times when I use additional spacing after the leading
> asterisk specifically for visual formatting, in particular when inside
> <code> tags, <pre> tags, and simple lists. See the "DocBlock Description
> Details" section of the PhpDocumentor manual for examples (
> http://pear.php.net/package/PhpDocu...tml#basics.desc
> ).
>
> Will this new restriction apply in these cases?
Sorry, I wrote the wrong thing there. This is for an asterisk on a line
with a tag, like @param. I can't enforce it elsewhere for the exact
reason you specified. I too often use indentation in comments to aid
readability.
Greg
|
|
|
|
|