PDA

View Full Version : Special PHP Comments



The Titan
April 13th, 2008, 04:04 AM
I have been looking around on phpclasses.org and i have been seeing a lot of comments like this one



/**
* Constructor. Initializes a database connection and selects our database.
*
* @param string Database host
* @param string Database username
* @param string Database password
* @param string Database name
* @return boolean
*/


I was wondering if there is anything "special" about these comments or are they just a common way of describing things and where can i learn more about them.

tamoneya
April 13th, 2008, 04:06 AM
a lot of times the comments are standardized so that you can run a program on the files and it can easily make and API that describes each function and its parameters.

The Titan
April 13th, 2008, 04:09 AM
like PHPdoc or something like that? Is there alike a syntax to these?

sillyxone
April 13th, 2008, 05:31 AM
<redundant>http://en.wikipedia.org/wiki/PHPDoc</redundant>