代码文档的注释及申明
多屏的项目一期结束后终于可以缓一下,有时间整理规范文档了,修改完善下文档的注释及文件头部申明部分,这里主要是借鉴和查看一些站点如(19楼、携程、易讯、QQ网购等)的源文件,整理较简短如下:
文件申明信息
- 文件头部添加申明信息,包含描述、作者、最后更新(更新人+更新时间);
示例供参考
/**
* Description: register style css (可中文)
* Author: JeffPan
* Update: JeffPan(2011-11-16 14:11)
*/注释
- 通过注释有效的组织管理代码文档,提升团队开发的合作效率,减少维护成本;
- 注释的形式 – 使用一致的标点和结构来注释代码,在维护他人的代码时不要使用新的注释形式,要顺延已有的注释形式,确保一致性;


