The DoYouHaoBaby PHP Framework中文开发文档手册
Copyright(c) DoYouHaoBaby.NET All Rights Reserved.
The DoYouHaoBaby PHP Framework中文开发文档手册
主页　 上级
[ 程序注释索引 ]

每个程序均必须提供必要的注释，书写注释要求规范，参照PEAR 提供的注释要求，为今后利用phpdoc 生成php 文档做准备。

（当然DoYouHaoBaby Framework有自己的注释要求，我们的常规注释要求如下。）

程序注释的原则如下：

注释内容必须写在被注释对象的前面，不写在一行或者后面；（特殊除外，一个大注释下，每个小注释就是例外）。例：

  1. /** 支持的URL模式 */  
  2. define( 'URL_COMMON',      0 );   //普通模式   
  3. define( 'URL_PATHINFO',    1 );   //PATHINFO模式   
  4. define( 'URL_REWRITE',     2 );   //REWRITE模式   
  5. define( 'URL_COMPAT',      3 );   //兼容模式  

 

程序中普通流程中注释采用/**  */，如：

  1. /** 版本信息 */  
  2. define( 'DYHB_VERSION', '1.1' );  

 

程序中普遍采用// 注释，不推荐使用/* */ 来注释，因为书写麻烦。例如：

  1. /**  
  2.  * 编译初始化  
  3.  *  
  4.  * @access public  
  5.  * @return void  
  6.  */  
  7.  private function  init_(){   
  8.   
  9.      // 判断编译Lock文件是否存在，不存在则创建整个目录   
  10.      if( !is_file( APP_RUNTIME_PATH.'/~Runtime.inc.lock' ) ){   
  11.          $this->buildApp();   
  12.   
  13.          // 声称编译标识文件   
  14.          DFile::createFile(APP_RUNTIME_PATH.'/~Runtime.inc.lock' );   
  15.      }   
  16.   
  17.      return;   
  18. }  

 

程序中如果出现数组，对每一项注释的话，可以采用/* */ ，当然也可以采用// 来书写。例如：

  1. return array(   
  2.   
  3.   /** 项目设置 */  
  4.   'APP_TYPE'          =>  3,    /* 项目类型，1：命令行，2：桌面，3：web,暂时只能是web项目 */  
  5.   'DEFAULT_APP'       =>  '@',  /* 默认APP,@表示当前项目 */  
  6.   'APP_GROUP_DEPR'    =>  '.',  /* APP项目分隔符 */  
  7.   'APP_GROUP_LIST'    =>  '',   /* 分组 */  
  8. );  

 

程序注释

主页　 主页 上级
[错误返回检测规则] 上级