2023年12月28日发(作者：)

Java 开发规范文档声明

• Package（包）命名

格式：.项目名.模块名 , 且全小写

Eg :

• 变量命名

变量的名字可大小写混用，但首字符应小写。词由大写字母分隔，限制用下划线，限制使用美元符（$），因为这个字符对内部类有特殊的含义。

Eg：userName 驼峰式 或 status 全小写

• Class（类）命名

Class的名字首字母大写,通常由多个单词合成一个类名，要求每个单词的首字母也要大写

Eg: DataFile或InfoParser

• Interface（接口）命名、

同3

• Static final变量（相当于常量）的命名

Static Final 变量的名字应该都大写，多个单词需下划线分开，并且指出完整含义。

Eg: final MAX_UPLOAD_FILE_SIZE=1024;

• 方法的命名

方法名的第一个单词应该是动词，大小写可混用，但首字母应小写。在每个方法名内，大写字母将词分隔并限制使用下划线。参数的名字必须和变量的命名规范一致。使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字

Eg: setUserName(String userName){me = userName}

• 数组的命名

byte[] buffer; 而不是：byte buffer[](习惯性问题而已)、

【归纳】尽量使用完整的英文描述符、采用适用于相关领域的术语、采用大小写混合使名字可读、尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一、避免使用长的名字（小于 15 个字母是个好主意）、避免使用类似的名字，或者仅仅是大小写不同的名字、避免使用下划线（除静态常量等）

• 注释规范

// 单行注释

/* */ 多行注释

/** */ Javadoc 注释（可生成Javadoc 在线文档）

• 注释模板

【方法注释模板】

/**

* @Title : ${enclosing_method}

* @Description : ${todo}

* @${tags}

* @author : ${user}

* @date : ${date} ${time}

* @UpdateBy : ${user}

* @date ${date} ${time}

*/

【类注释】

/**

* @ClassName ${type_name}

* @Description ${todo}

* @author ${user}

* @date ${date} ${time}

*/

• 工具类命名

避免使用无意义的命名，首字母大写，每个单词首字母也大写，以Util 结尾

Eg: md5算法工具类

• 资源文件，帮助类等存储声明

工程资源文件放 -- src/resources

工程公共类 – src/kk/pn/common

工程自定义工具类 – src/kk/pn/utils

其中，kk: 公司名简写；pn: 项目名称简介（ProjectName）

• 其他细节

代码优雅，整齐划一，错落有序。对于业务复杂的代码处，适当注释。

其他日后补充。