产品开发部代码注释规范1.1

《产品开发部代码注释规范1.1》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、产品开发部代码注释规范版本：1.1版本号作者修改内容说明时间1.0何晨曦初稿2013-03-251.1赵华忠增加JS和CSS部分2013-03-291.参考文档1.《Java编码规范》.doc2.《开发管理规范》.doc3.《前台页面编码规范》.doc2.注释规范2.1.XML配置文件1.对于一些重要配置以及mybatis中的重要SQL，用“”进行注释。2.2.属性配置文件1.properties配置文件的编码最好采用ISO-8859-1,因为properties默认采用该编码，输入的中文会转换成一

2、种特殊的形式。如果强制设置成其他编码，可能会因为环境的不同造成一些意外情况。2.统一采用“#”进行注释，注释内容与“#”隔一个空格。3.“#”写在行首。2.3.Java程序类注释：请更新MyEclipse注释模板【菜单-Preferences-Java-CodeStyle-CodeTemplates-Comments-Types】/***程序说明：${tags}
*****************************
*序号:
*创建者:
*说明:
*日期:
*

3、****************************
*序号:
*修改者:
*说明:
*日期:
**@author${user}${date}${time}*@version1.0*/建议类修改变动比较大的，开发更换新版本。1.使用eclipse为方法生成注释，主要描述方法的功能，方法的参数，方法的返回值。2.对于接口以及实现类，在接口中为方法写注释，实现类可以不写。3.类与接口中的私有字段，要写注释，采用“//”与字段在同一行，注释与“//”隔一个空格。4.类与接口中

4、的公有常量，采用“/***/”形式。5.程序段中的重要逻辑要写注释，好的注释不是描述每一行代码干什么，而是描述代码为什么要这么写。6.修改代码段加入说明。//Modifybyauthorattime：修改代码段//Modifyend1.1.JSP文件JSP中的注释采用“<%----%>”这种注释不会出现在最终声称的HTML代码中。1.2.JS脚本类似Java程序注释1.使用eclipse为方法生成注释，主要描述方法的功能，方法的参数，方法的返回值。2.函数中使用到的变量字段，要写注释，采用“//”与字段在同一行，

5、注释与“//”隔一个空格。3.对于公有常量，采用“/***/”形式。4.重要逻辑要写注释，好的注释不是描述每一行代码干什么，而是描述代码为什么要这么写。1.3.自定义CSS一般不需要自定义样式，样式统一由产品设计部提供，并统一定义样式注释采用/***/方式。标示出样式的作用和用途，用到的功能或者模块说明。1.参考示例1.1.XML配置文件1.2.属性配置文件1.3.Java程序类注释：/****程序说明：服务器启动主程序，基于Jetty启动Web服务器，端口为8008
******************

6、***********
*序号:1
*创建者:zhaohuazhong
*说明:实现启动主程序
*日期:2013-4-916:30:10
*****************************
*序号:
*修改者:
*说明:
*日期:
**@authorzhaohuazhong2013-4-916:30:10*@version1.0*/publicclassKylinServer{{}1.使用eclipse为方法生成注释，主要描述

7、方法的功能，方法的参数，方法的返回值。1.对于接口以及实现类，在接口中为方法写注释，实现类可以不写。2.类与接口中的私有字段，要写注释，采用“//”与字段在同一行，注释与“//”隔一个空格。3.类与接口中的公有常量，采用“/***/”形式。1.程序段中的重要逻辑要写注释，好的注释不是描述每一行代码干什么，而是描述代码为什么要这么写。1.1.JSP文件<%----%>1.1.JS脚本1.2.自定义CSS