The DoYouHaoBaby PHP Framework中文开发文档手册
Copyright(c) DoYouHaoBaby.NET All Rights Reserved.
The DoYouHaoBaby PHP Framework中文开发文档手册
主页　 上级
[ 其它特殊注释 ]
另外DoYouHaoBaby 还有其它一些注释规定：

函数（包括类和接口）中的功能或者注意事项的一些描述统一采用如下格式进行注释，<>注释一条条语句，语句如果太长则回车换行

  1. /**  
  2.  * 路径断言，检查传入变量所代表的路径是否有效。  
  3.  *    
  4.  * <!-- 我是标题 -->  
  5.  * < 此断言 不对文件或目录作出判断。>  
  6.  *   
  7.  * @access  public  
  8.  * @param   $Var    mixed   传入检查的路径  
  9.  * @param   $sDes=null  string  当断言异常被触发时，描述该断言的消息  
  10.  * @return  void  
  11.  */  

类或者接口中函数分类标题以类似的方式分割。例如：

  1. class test{   
  2.   
  3.     /** ========================== test1 ============================ */  
  4.     function test1( ){ }   
  5.     function test2( ){ }   
  6.   
  7.     /** ========================== test2 ============================ */  
  8.     function test3( ){ }   
  9.     function test4( ){ }   
  10.   
  11. }  

程序中如果类的属性太多，而且很多属性相似，那么注释第一个，其它的可以不用注释，也可以//加上注释，如

  1. /**  
  2.  * 日志优先级设置，级别由低到高  
  3.  *   
  4.  * @access const  
  5.  * @var String  
  6.  * @const  
  7.  */  
  8. const EMERG     = 'EMERG';   // 严重错误: 导致系统崩溃无法使用   
  9. const ALERT     = 'ALERT';  // 警戒性错误: 必须被立即修改的错误   
  10. const CRIT      = 'CRIT';   // 临界值错误: 超过临界值的错误，例如一天24小时，而输入的是25小时这样   
  11. const ERR       = 'ERR';   // 一般错误: 一般性错误   
  12. const WARN      = 'WARN';    // 警告性错误: 需要发出警告的错误   
  13. const NOTICE    = 'NOTIC';   // 通知: 程序可以运行但是还不够完美的错误   
  14. const INFO      = 'INFO';   // 信息: 程序输出信息   
  15. const DEBUG     = 'DEBUG';   // 调试: 调试信息   
  16. const EXCEPTION = 'EXCEPTION';//异常日志记录   
  17. const SQL       = 'SQL';   // SQL：SQL语句 注意只在调试模式开启时有效  

主页
上级