[SOLVED] OOP commenting

[gevans]

Hey guys,

 

I'm just writting some new classes, updating my old db script to mysqli, that sorta stuff. I'm about to go through and comment them all nicely for myself and other people that I share development jobs with. Is there an example somewhere of the 'correct syntax' for commenting in OOP?

 

I used to do something like this;

 

    /**
    * Connect to dbms and database
    * @param string c - main config array
    * @access public
    */
    public function __construct($C){
        $this->url = $C['URL'];
        $this->email = $C['ADMIN'];
        if(!$this->mysql = mysql_connect($C['DB']['HOST'],$C['DB']['USER'],$C['DB']['PASS'])) return $this->error('There was a problem loging in to the database.', mysql_errno($this->mysql).' - '.mysql_error($this->mysql));
        if(!$this->database = mysql_select_db($C['DB']['DB'], $this->mysql))return $this->error('There was a problem connecting to the database.', mysql_errno($this->mysql).' - '.mysql_error($this->mysql));
        return true;
    }

 

Just wanted to make sure I was sticking to some sort of standard.

[Mchl]

Are you using any tool for generating documentation automatically? If yes, you should just follow it's syntax.

[gevans]

No I'm not, I'm writting all my code in Notepad++ so it's giving me nothing!

[Mchl]

Still you could use a tool like Doxygen, or PHP Documentor, that parses such comments, and produces nicely formatted HTML documentation.

[gevans]

Not exactly what I was looking for, but by working through the documentation of PHP Documentor I'm able to pull out good practice syntax, so thank you very much!