PHPDoc comments and dots.

Not for 'how-to' coding questions but PHP theory instead, this forum is here for those of us who wish to learn about design aspects of programming with PHP.

Moderator: General Moderators

Post Reply
User avatar
kaisellgren
DevNet Resident
Posts: 1675
Joined: Sat Jan 07, 2006 5:52 am
Location: Lahti, Finland.

PHPDoc comments and dots.

Post 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.
User avatar
Weirdan
Moderator
Posts: 5978
Joined: Mon Nov 03, 2003 6:13 pm
Location: Odessa, Ukraine

Re: PHPDoc comments and dots.

Post 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.
User avatar
kaisellgren
DevNet Resident
Posts: 1675
Joined: Sat Jan 07, 2006 5:52 am
Location: Lahti, Finland.

Re: PHPDoc comments and dots.

Post 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? :|
User avatar
Weirdan
Moderator
Posts: 5978
Joined: Mon Nov 03, 2003 6:13 pm
Location: Odessa, Ukraine

Re: PHPDoc comments and dots.

Post 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.
Post Reply