My PHP IDE does not seem to recognize /** as the beginning of PHP comments. It does recognize /* as the beginning, however.

When I see other's code, I often see /** used to begin PHP comments.

Question: Is the /* comment */ method pretty much accepted everywhere?

Thanks,
Dave

I think /** is what PHPDoc looks for before it parses comments.

What is your IDE just out of interest, it sounds like there syntax matching algo is incorrect.

__________________
mysql> SELECT * FROM `users` WHERE `users`.`clue` > 0;
Empty set (0.00 sec)

In Java, Javadoc (the equivalent of PHPdoc) uses /** */ comments for Javadoc comments and /* */ for plain comments.

I tend to use a /** */ when doing a multiline comment, a /* */ on an line comment detailing a section of code and a // when detailing the next few lines.

For example:

That is interesting. I use gedit for Linux and it recognizes anything starting with /* as a comment. Thus /***** counts as a comment, and *****/ counts as a closing comment.

What IDE do you use? Because PHP should ignore anything between the "/*" and "*/" tags regardless of what they are.

__________________

Here is an example:

/**
* Applies the main template to the page
*
* @param string $file
* @param bool $first
*/

If the PHP parser spots /** it starts reading the whole comment block for later (possible) usage. So /** is not just for yourself, but it's actually used in parsetime (i will explain later). When using /* it will be just ignored.

The good thing about /** is for combinating /** information with the Reflection API, you can creating your own doc system.

Also very nice is using it in Zend Studio. When you are working on some others code, some sort of API. You can see much information about a function without looking in the code of the API writher, because ZS shows you the information from /** when starting the function.

You have to check it out to be convinced :)

__________________
Nunchaku! Who doesn't like martial arts? =)

This is a PHPDoc block comment, therefore its for the PHPDoc parser not PHP parser itself and as VI correctly said:
Im guessing that Zend Studio (and indeed eclipse) reads PHPDoc comments and uses them to provide more comprehensive code completion hints.

The double '*' is there for the PHPDoc parser, as far as i know.

__________________
mysql> SELECT * FROM `users` WHERE `users`.`clue` > 0;
Empty set (0.00 sec)

That is interesting, and clears up the /* vs. /** "issue" up for me very well. Thank you!

Dave

Additional to my first post, it might be intressting to note that you can actually read the /** comments on runtime in PHP yourself :)

__________________
Nunchaku! Who doesn't like martial arts? =)

I used # or ## myself. Works just as good.

I dont use '#' because it looks like the she-bang line when running PHP on the CLI:

__________________
mysql> SELECT * FROM `users` WHERE `users`.`clue` > 0;
Empty set (0.00 sec)

I don't use hash because it just looks ugly to me

That too

__________________
mysql> SELECT * FROM `users` WHERE `users`.`clue` > 0;
Empty set (0.00 sec)

PERL style comments should be terminated, just like asp_tags =P

__________________

asp itself should be terminated. All hail php and that #