java代码编写规范

《java代码编写规范》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、JAVA代码编写规范文件状态：[]草稿[√]正式发布[]正在修改文件标识：ACEWAY-JAVA-CODE-CONVENTION.doc当前版本：2.0作者：钟波清、黄承宇完成日期：保密级别：机密公司名称：北京汉铭信通科技有限公司公司地址：北京市朝阳区安翔北里11号创业大厦B座11层邮政编码：100101公司网址：WWW.ACEWAY.COM.CN联系电话：010-64858989传真：010-64853939ACEWAY-JAVA-CODE-CONVENTION.docJAVA代码编写规范修改记录

2、日期版本作者/修改者描述审核人2006-03-141.0钟波清新建文档2012-07-022.0黄承宇更新文档、调整章节、增加Eclipse模板文件北京汉铭信通科技有限公司北京市朝阳区安翔北里11号创业大厦B座11层邮编：100101电话：010-64858989传真：010-64853939www.aceway..com.cn18ACEWAY-JAVA-CODE-CONVENTION.docJAVA代码编写规范目录1.引言31.1.目的31.2.适用范围31.3.参考资料31.4.缩略语和术语32

3、.规范描述42.1.字符编码42.2.命名规定42.2.1.包的命名52.2.2.类或接口命名52.2.3.常量命名62.2.4.变量命名62.2.5.方法命名72.2.6.数组命名72.3.格式72.3.1.缩进72.3.2.空格(建议)82.3.3.行宽92.3.4.花括号(建议)112.3.5.空行（建议）112.3.6.Eclipse格式模板132.4.注释142.4.1.类的注释152.4.2.Eclipse代码模板162.5.编程惯例18北京汉铭信通科技有限公司北京市朝阳区安翔北里11号

4、创业大厦B座11层邮编：100101电话：010-64858989传真：010-64853939www.aceway..com.cn18ACEWAY-JAVA-CODE-CONVENTION.docJAVA代码编写规范1.引言1.1.目的为编码活动中提供统一标准的编码规范，便于将来对代码文件的审查、管理工作。1.2.适用范围用于编码过程中JAVA代码的编写规范。1.3.参考资料资料名称『标识符』出版单位作者日期CodeConventions.pdfSun1997.9.121.4.缩略语和术语缩写原文

5、中文释意北京汉铭信通科技有限公司北京市朝阳区安翔北里11号创业大厦B座11层邮编：100101电话：010-64858989传真：010-64853939www.aceway..com.cn18ACEWAY-JAVA-CODE-CONVENTION.docJAVA代码编写规范规范描述1.1.字符编码Java源代码文件采用UTF-8字符编码，JavaDOC也采用UTF-8字符编码。建议新建项目或CheckOut项目后，第一个操作先修改项目的编码配置。或者修改Eclipse的全局配置，默认项目使用UTF

6、-8编码。输出JavaDOC时，增加“-encodingUTF-8-charsetUTF-8”配置，防止文档内容乱码。如图：1.2.命名规定命名总则：²使用“见名知义”的名称。如：age、name。²使用熟悉的名称或者适用于相关领域的术语。如：SQLAdapter、HTMLCreator。²尽量不使用缩写，而使用完整的英文描述符。如：sgntr，很难知道它是否为signature。²使用大家基本可以理解的缩写，避免使人产生误解。如：北京汉铭信通科技有限公司北京市朝阳区安翔北里11号创业大厦B座11层

7、邮编：100101电话：010-64858989传真：010-64853939www.aceway..com.cn18ACEWAY-JAVA-CODE-CONVENTION.docJAVA代码编写规范temp可缩写为tmp；flag可缩写为flg；statistic可缩写为stat；increment可缩写为inc；message可缩写为msg。²不要使用相似的名称，或者仅仅以大小写不同来区分的名称。²不要使用超过20个字母长度的名称。²在不能遵循本命名规范的代码中，一定要在代码中以文档注释格式说明

8、命名的中文名称和含义。如：“/**dishi:地市，三级区域代称*/”。1.1.1.包的命名包名应该是小写的单词或者单词缩写。前缀一般是：²一个顶级域名，通常是com、edu、gov、mil、net、org；²1981年ISO3166标准所指定的标识国家的英文双字符代码。如cn；²一个能够表明该包的用途的单词或者单词缩写。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门、项目、机器或注册名。例如：packagecom