TalkPHP - View Single Post

xperience · 05-22-2008, 06:24 PM

How do you comment your code ? If it's one thing I really suck at is understanding how to correctly comment my code. I've read some things over the internet, but with still no luck.

How do you comment variables

PHP Code:


			
    /*

    * 

    * @var array

    *

        */

    public $getinfo;

    

    /*

    *

    * @var array 

    *

        */

    private $connection;

Is something like that feasible? What else would you include ? What would you change? How about a class, a function, etc ?

05-22-2008, 06:24 PM	#1 (permalink)
xperience The Wanderer Join Date: Dec 2007 Posts: 18 Thanks: 2	Commenting code How do you comment your code ? If it's one thing I really suck at is understanding how to correctly comment my code. I've read some things over the internet, but with still no luck. How do you comment variables PHP Code: `/* * * @var array * / public $getinfo; / * * @var array * */ private $connection;` Is something like that feasible? What else would you include ? What would you change? How about a class, a function, etc ?