Start comments in PHP: /* or /**
View Single Post
09-04-2008, 08:14 PM
Join Date: Nov 2007
Location: the Netherlands
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 :)
Who doesn't like martial arts? =)
The Following 2 Users Say Thank You to Jim For This Useful Post:
View Public Profile
Send a private message to Jim
Visit Jim's homepage!
Find More Posts by Jim