PHPDoc : Différence entre versions

Version du 26 mai 2009 à 13:16

Commenter un code est la meilleure aide que vous pouvez donner aux développeurs qui réutiliseront votre code.

Pour cela, nous conseillons d'utiliser la syntaxe de PHPDoc pour vos commentaires. PHPDoc est une adaptation de JavaDoc au langage PHP. Un commentaire écrit en PHPDoc sera facilement compréhensible par un développeur ainsi que par des logiciels générateurs de documentations (PHPDocumentor, Doxygen, PHPDoc...).

<source lang="php"> /**

    * Output File was config object, now just string
    * Used to generate the Tables
    *
    * @var    string outputbuffer for table definitions
    * @access private
    */
   var $_newConfig;

   /**
    * Build a list of tables;
    * and store it in $this->tables and $this->_definitions[tablename];
    *
    * @access  private
    * @return  none
    */
   function mafonction() {
      
   }

</source>