逐风PHP文档注释规范个人总结

编辑:逐风博客 2016-06-13 09:16:24 阅读热度:0

文件头部模板

// +----------------------------------------------------------------------
// | 项目名称 [ 文档功能简要描述 ]
// +----------------------------------------------------------------------
// | Copyright (c) 2016-2016 版权 All rights reserved.
// +----------------------------------------------------------------------
// +----------------------------------------------------------------------
// | Author: Chenjl 
// +----------------------------------------------------------------------

函数/方法头部注释

/**
 * 函数/方法作用描述
 * 
 * @access  public 
 * @version 0.0.1
 * @Author  Chenjl  * 
 * @return  mixed | void
 */

程序代码注释

  1. 注释的原则是将问题解释清楚,并不是越多越好。

  2. 若干语句作为一个逻辑代码块,这个块的注释使用:/* */方式。

  3. 具体到某一个语句的注释,可以使用行尾注释://。


[转] 编程巨星的唯一成功的秘诀
逐风API接口规范个人总结
逐风开发在线 逐风

懒惰:是这样一种品质,它使得你花大力气去避免消耗过多的精力。它敦促你写出节省体力的程序,同时别人也能利用它们。为此你会写出完善的文档,以免别人问你太多问题。