Java编程规范

迈不过友情╰ 2024-03-27 13:01 66阅读 0赞

![604ea461d27946f3b500cfe959ba6b46.png][]

### 一、Java命名约定 ###

#### 1、Java中的名称 ####

包（Package）名、类（Class）名、接口（Interface）、变量名、方法名、常数名。

#### 2、Java对于名称命名的约定的基本原则 ####

\_、$不作为变量名，方法名开头

变量名、方法名首单词小写，其余单词只有首字母大写，如anyVariableWorld

接口名、类名首单词第一个字母大写

常量：完全大写

#### 3、各种命名原则 ####

（1）包的命名规则

包名采用完整的英文描述符，应该都是由小写字母组成。如 com.taranis.graphics

（2）类、接口以及枚举类型的命名规则

类名、接口名以及枚举类型名都采用完整的英文描述符，并且所有单词的第一个字母大写。 如Customer, SavingsAccount

（3）变量的命名规则

类的属性（变量）采用完整的英文描述符，第一个字母小写，任何中间单词的首字母大写。 如firstName

方法的参数命名规则与属性的命名规则相同

局部变量的命名规则与属性的命名规则相同

（4）常量或静态常量（static final）

全部采用大写字母，单词之间用下划线分隔。如 MIN\_BALANCE

（5）方法的命名规则

普通成员方法采用完整的英文描述说明成员方法功能，第一个单词要采用一个生动的动词，第一个字母小写。例如 openFile()

属性存取器方法采用访问属性名的前面加上前缀 get，如 getFirstName()；被访问字段名的前面加上前缀set， 如setFirstName()

（6）GUI组件的命名规则

首先使用完整的英文描述来说明组件的用途，其后加上组件类型， 如cancelButton

### 二、Java注释规则 ###

#### 1、基本原则 ####

注释应该增加代码的清晰度

注释要简洁

在写代码之前写注释

注释中不仅指出代码做了什么，还要进一步指出这样作的原因

#### 2、三类注释的使用 ####

文档注释 /\*\* \*/

C 语言风格注释 /\* \*/

单行注释 //

### 三、Java源文件结构规则 ###

Java 源文件(\*.java)都必须遵守如下的样式规则：

版权信息必须在 java 文件的开头

package/imports 语句

类定义，可分为类注释、类声明和类体的定义

代码行缩进应该采用统一的单位

源文件页宽应该设置为80字符

“\{ ”、“\}”以及\{\}中的语句都应该单独一行。“\{ ”应紧跟在它的所属语句的后面，“\}”单独一行

左括号和后一个字符之间不应该出现空格； 同样， 右括号和前一个字符之间也不应该出现空格

使用一个空行来划分代码的逻辑组

### 四、编程建议 ###

1、成员方法的30秒原则和第32条原则

其他编程人员应能够在30秒内完全理解方法的功能及实现过程

成员方法不要太长，一个成员方法体能够在一个屏幕（通常是32条语句）内显示

2、尽量减少公共(public)和受保护(protected)的接口

3、提高程序性能需注意的问题

不要在循环中创建和释放对象

使用 StringBuffer 对象

避免过多使用 synchronized 关键字

4、编写代码建议

注重程序的易读性，遵守编程规范，编写干净代码

先设计，后编码

一小步一小步的逐步开发

保持代码简洁

[604ea461d27946f3b500cfe959ba6b46.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d1007c08ac284294a893eddbf725ba2e.png

发表评论取消回复

表情：

评论列表（有 0 条评论，66人围观）

还没有评论，来说两句吧...

相关阅读

相关 Java编程规范

![604ea461d27946f3b500cfe959ba6b46.png][] 一、Java命名约定 1、Java中的名称包（Package）名、类（Cla

迈不过友情╰/ 2024年03月27日 13:01/ 0 赞/ 67 阅读

相关 Java编程规范-注释

注释加上注释，格式尽量和规范保持一致 Java 程序有两类注释：实现注释 (implementation comments) 和文档注释 (document c

た入场券/ 2023年10月08日 12:55/ 0 赞/ 46 阅读

相关 Java编程规范(代码规范)--精选

原文网址：[Java编程规范(代码规范)--精选\_IT利刃出鞘的博客-CSDN博客][Java_--_IT_-CSDN] 简介说明本文介绍精选的Java编程规范

蔚落/ 2023年09月23日 21:49/ 0 赞/ 133 阅读

相关 java的编程规范_java 编程规范

包名统一小写, 点分隔符之间有些仅能有一个单词, 并且单词必须是小写, 类名可以是复数形式正: com.alibaba.open.util.MessageUtils 接口

Bertha 。/ 2022年11月09日 11:26/ 0 赞/ 218 阅读

相关 Java编程规范

为什么要有编码规范？一个软件的生命周期中，80%的花费在于维护几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护编码规范可以改善软

我会带着你远行/ 2022年07月16日 03:51/ 0 赞/ 285 阅读

相关编程规范

指导你避免写出坏代码！ 1、编程时指导思想的优先级顺序。第一优先级正确性：功能性需求健壮性：异常处理第二优先级可维护性：代码是给人看的！可移植性：代码

系统管理员/ 2022年05月17日 23:15/ 0 赞/ 201 阅读

相关【Java】Java编程规范

以下内容摘录自Java编程思想一书。 1. 类名首字母应该大写，字段、方法以及对象（句柄）的首字母应该小写。对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单

水深无声/ 2022年05月15日 06:54/ 0 赞/ 201 阅读

相关编程规范

java Java Coding Guidelines [https://wiki.sei.cmu.edu/confluence/display/java/SEI+CE

小咪咪/ 2022年02月02日 12:55/ 0 赞/ 311 阅读

相关 Java编程规范

编程规范是对编程的一种约定，主要作用是增强代码的可读性和可维护性，便于代码重用。首先要求程序中的各个要素都遵守命名规则，然后在编码中严格按照编码格式编写代码。命名规

绝地灬酷狼/ 2021年12月20日 13:09/ 0 赞/ 241 阅读

相关 Java编程规范

[林炳文Evankaka][Evankaka]原创作品。转载请注明出处[http://blog.csdn.net/evankaka][http_blog.csdn.net_e

深藏阁楼爱情的钟/ 2021年09月10日 13:16/ 0 赞/ 424 阅读