Java代码编写规范(参考)

2022-05-19 14:27:21 文档大全网 [ 字体：小中大 ] [ 阅读： ]

【#文档大全网# 导语】以下是®文档大全网的小编为您整理的《Java代码编写规范(参考)》，欢迎阅读！
编写,规范,参考,代码,Java
命名规范：

1. 所有的标识都只能使用ASCII字母（A-Z或a-z）、数字（0-9）和下划线”_”。

2. 一个唯一包名的前缀总是用全部小写的字母。

3. 类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。

4. 接口的大小写规则与类名相似。

5. 方法名是一个动词或是动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

6. 变量名的第一个字母小写，任何中间单词的首字母大写，变量名应简短且可以顾名思义，易于记忆。避免单个字符的变量名，除非是一次性的临时变量。

7. 常量的声明应该全部大写，每个单词之间用”_”连接。注释规范：

1. 注释尽可能使用”//”,对于所有的Javadoc的注释使用/***/，而临时对代码块进行注释应尽量使用/**/。

2. 所有的源文件都应该在开头有一个注释，其中列出文件名、日期和类的功能概述。每个方法必须添加文档注释（main除外）。 3. 每个属性必须加注释。 4. 代码中至少包含15%的注释。 5. 注释使用中文。

缩进排版规范：

1. 避免一行的长度超过60个字符。

2. 使用Eclipse源代码的格式化功能完成代码的缩进排版。文件名规范：

1. 一个Java源文件只能储存一个Java类。 2. 文件名与Java类相同。 3. 一个类文件不超过200行。声明规范：

1. 一行声明一个变量。

2. 不要将不同类型变量的声明放在同一行。 3. 只在代块的开始处声明变量。 4. 所有的变量必须在声明时初始化。

5. 避免声明的局部变量覆盖上一级声明的变量。 6. 方法与方法直接以空行分隔。语句规范：

1. 每行至少包含一条简单语句。

2. 在return语句中，返回值不使用小括号”()”括起来。 3. If月总是用{和}括起来。

4. 在for语句的初始化或者更新子句中，避免因使用3个以上变量，而导致复杂度提高。

5. 当switch的一个case顺着往下执行时（因为没有break），通常应在break语句的位置添加注释。

其他：

为了防止再写if的判断语句时把i==3,错写成i=3,可以将i==3的写法改为3==i。