Welcome Guest, Not a member yet? Register   Sign In
Code Committing Help/Advice
#6

[eluser]Vega[/eluser]
I'd recommend docblock style comments so other people and yourself can quickly tell what the method parameters and return type is - although this is not really necessary for controller methods in my opinion. I only really add comments within methods if it's doing something unusual.

So above each method use something like:

Code:
/**
  * Description of method
  *
  * @param  int
  * @param  array
  * @access public
  * @return  boolean
  */


Messages In This Thread
Code Committing Help/Advice - by El Forum - 11-20-2012, 07:14 PM
Code Committing Help/Advice - by El Forum - 11-20-2012, 10:44 PM
Code Committing Help/Advice - by El Forum - 11-20-2012, 10:46 PM
Code Committing Help/Advice - by El Forum - 11-20-2012, 11:36 PM
Code Committing Help/Advice - by El Forum - 11-21-2012, 05:47 AM
Code Committing Help/Advice - by El Forum - 11-21-2012, 06:34 AM



Theme © iAndrew 2016 - Forum software by © MyBB