comments on what the function does php code example
Example 1: php proper function comments
/**
* This function compiles a message that tells you how great coffee is
*
* @param string $compliment A nice word to describe coffee
* @param integer $score A score out of 10
*/
Example 2: comment in php
MSpreij (8-May-2005) says /* .. */ overrides //
Anonymous (26-Jan-2006) says // overrides /* .. */
Actually, both are correct. Once a comment is opened, *everything* is ignored until the end of the comment (or the end of the php block) is reached.
Thus, if a comment is opened with:
// then /* and */ are "overridden" until after end-of-line
/* then // is "overridden" until after */