TS-GF-01-JAVA程序编码规范.docVIP

JAVA程序编码规范 编制：： 时间 作者 修订版本 目 录 1 目的 1 2 范围 1 3 规范 1 3.1 命名规范 1 3.1.1 包名 1 3.1.2 文件名、类名 2 3.1.3 变量名 3 3.1.4 函数/方法名 4 3.2 注释 4 3.2.1 总体要求 4 3.2.2 方法及格式 5 3.2.2.1 类注释 5 3.2.2.2 函数注释 5 3.2.2.3 方法内部注释 6 3.2.2.4 全局变量注释 6 3.2.2.5 局部/中间变量注释 7 3.2.2.6 参数注释 7 3.2.2.7 属性注释 7 3.2.2.8 常量注释 7 3.3 排版规范 7 目的 本文档的目的通过组织的java程序编码规范下几要求：统一软件开发过程的编程规范 通过编码规范提高软件代码的可读性，使得开发人员快速和彻底的理解新代码，极大的了软件的维护成本 通过对编码过程规范化，为良好的行为习惯 范围 本规范适用于JAVA开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 命名规范 包名 包的命名规范应当能体现出项目资源良好的划分用于不同功能的类分门别类，放在不同的目录（）的命名下： 公司域名反转作为包名开。如名开头就是 com.xxx 不同功能或子系统项目划分后的名称，并以“”号连接包名开头后面如：系统管理子系统取名system，那么包名就是：字母都小写 使用英文单词，使人员一目了然 首字母大写 是由多个单词组成那么每个单词的首字母都大写而且中间不要任何的连接符 有意义的名字必须保证准确、简洁且容易理解，能快速地传达该类的用途 使用完整单词，避免使用拼音或缩写词（了大家公认的） 要区别接口类和实现类的时候，在实现类的后面加上“impl”如：类Interface.java 接口实现类InterfaceImpl.java 变量名 选择有意义的名字，能快速地传达该变量的用途 字母小写开头，每个单词字母大写 命名的基本结构为：+变量名，使用字符前缀来表示数据类型 ：一个整形变量intDocumentCount其中数据类型，后面为表意的英文单词组合，每个单词首字母大写 类型前缀做数组用时，再加前缀-a，如：字符串数组，astrUserName 自定义类型的变量可以采用本身的名称，把首字母改为小写且要能代表在中的意义，如：员工列表Boolean bln integer/int int short sht Long/long lng Double/double dbl string str 除非是在循环中，否则一般不要使用单个字母作为变量名，i、j、k等只作为小型循环的循环索引变量 变量采用全部大写的形式来书写，对于采用多词合成的变量采用“_”来连接各单词如：ROOT_PATH 选择有意义的名字，能快速地传达该变量的用途 字母小写开头，每个单词字母大写 表示一种行为，它代表一种动作，最好是一个动词或者动词词组，如：searchXxxxxxdeleteXxxxxYyyy 属性方法，以，其后跟字段名称，字段名称字母大写。如getUserName() 注释 总体要求 是开发规范中为重要的部分，必须严格执行 形式统一：整个软件产品，使用具有一致的标点和结构的样式来构造注释 要简洁：内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害 的一致性：代码的同时修改相应的注释，以保证代码与注释的同步 数量：占程序的比例得低于% 必加的：算法有注释代码不明晰不可移植要加注释、错误修复方法的注释、循环和逻辑分支的代码添加注释 及格式 注释 注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息模版： /** 名称如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明人姓名日期，：yyyy-mm-dd*/ 函数注释 函数注释采用 /** ……*/，在每个函数或者过程的前面要有必要的注释信息注释模版： /** * * 返 回 值: - 类型 说明 * 返回为空（void）的构造函数或者函数，@return可以省略; 如果返回值就是输入参数，必须用与输入参数的@param相同的描述信息; 必要的时候注明特殊条件写的返回值。 * 异 常：按照异常名字的字母顺序 * 创 建 人: * 日 期: * 修 改 人: * 说 明：修改的内容 * 日 期: */ 方法内部注释 内部注释主要用于控制代码的结构，代码做了些什么以及为什么这样做，