Page 1 of 1

PHPDoc comments and dots.

Posted: Sun Jun 14, 2009 9:18 am
by kaisellgren
Hello,

I've been working with Zend Studio a lot and I wonder why I can't have a dot "." in a comment without the rest of it getting cutted? For example:

Code: Select all

/**
* Something with a dot. More text.
* Continues to next line.
*/
Now when I view it in Zend Studio, I will only see "Something with a dot" and that's it. Is there a reason why it cuts the rest of the comment? Sometimes I may want to have more than one sentence..

I'm not sure if this is the appropriate forum for this, but I don't think this belongs to PHP Code -forum.

Re: PHPDoc comments and dots.

Posted: Sun Jun 14, 2009 10:01 am
by Weirdan
It's javadoc convention - everything before the first dot is a short description (and gets shown by Zend) and everything after is a detailed description.

Re: PHPDoc comments and dots.

Posted: Sun Jun 14, 2009 12:17 pm
by kaisellgren
So, if I'm unable to explain a method (for instance) with a single sentence, I just face the facts that I can't explain it? :|

Re: PHPDoc comments and dots.

Posted: Sun Jun 14, 2009 1:17 pm
by Weirdan
I don't know. Since I don't use ZS, I, actually, don't care and use as many sentences as I feel required.