Welcome Guest, Not a member yet? Register   Sign In
Better comments phpdoc on functions
#1

[eluser]Lechuss[/eluser]
Hi,

Would you - Developers - write a better comments on functions? Something like that:

GOOD:
Code:
/*
* Generates a SELECT MAX(field) portion of a query
  *
  * @param string the field
  * @param string an alias
  * @return object
  */
public function select_max($select = '', $alias = '')

BAD (missing description of pamateres):
Code:
/**
* Sets the OR HAVING value
*
* Separates multiple calls with OR
*
* @param string
* @param string
* @return object
*/
public function or_having($key, $value = '', $escape = TRUE)


It helps to work with autocomplete in Netbeans.


Messages In This Thread
Better comments phpdoc on functions - by El Forum - 05-28-2012, 06:40 AM
Better comments phpdoc on functions - by El Forum - 05-28-2012, 10:48 PM
Better comments phpdoc on functions - by El Forum - 05-29-2012, 12:43 AM
Better comments phpdoc on functions - by El Forum - 05-29-2012, 12:17 PM



Theme © iAndrew 2016 - Forum software by © MyBB