JAVA入门（五）--------编码规范

最新推荐文章于 2023-06-14 22:15:01 发布

原创最新推荐文章于 2023-06-14 22:15:01 发布 · 195 阅读

0 ·

CC 4.0 BY-SA版权

JAVA编程专栏收录该内容

92 篇文章

订阅专栏

本文详细介绍Java项目的命名规范、注释规范及代码规范，包括小驼峰法、大驼峰法的使用场景，类、方法、变量的命名原则，以及代码布局、空格使用等细节，为开发者提供清晰的编码指引。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一. 命名规范

1. 项目名：全部小写

2. 包的命名：

全小写字母，中间用点分开，

作为命名空间，包名应该具有唯一性，推荐采用公司或者组织域名的倒置，如com.apple.quicktime.v2

但是Java核心库包名不采用域名的倒置命名，如java.awt.event

3. 类和接口：采用大驼峰法，如 public class MyFirstClass{}

4. 变量：采用小驼峰法，如studentNumber

5. 常量名

全大写，如果是由多个单词构成，可以用下划线隔开，如YEAR, WEEK_OF_MONTH

6. 方法名：采用小驼峰法，如balanceAccount,isButtonPressed

二. 注释规范

1. 类注释

Eclipse自动生成作者、日期注释等功能设置 - smallyaohailu - 博客园

https://www.cnblogs.com/anpajin/p/6376722.html

【Alt + Shift + J】

/**

* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

* FileName: Test.java

* 类的详细说明

*

* @author 类创建者姓名
* @Date 创建日期

* @version 1.00

*/

/*
* 版权所有 2015 北京智捷东方科技有限公司
* 许可信息查看LICENSE.txt文件
* 描述:
*   实现日期基本功能
* 历史版本:
*   2015-7-22: 创建 关东升
*   2015-8-20: 添加socket库
*   2015-8-22: 添加math库
*/

2. 代码注释

CTRL + /: 单行注释 “//”

CTRL+Shift + /：多行注释

3. 方法注释

/**

* 类方法的详细使用说明

*

* @param 参数1 参数1的使用说明

* @return 返回结果的说明

* @throws 异常类型.错误代码注明从此类方法中抛出异常的说明

*/

三. 代码规范

3.1 空行

（1）类声明和接口声明之间保留两个空行

（2）两个方法之间保留一个空格

（3）方法的第一条语句之前保留一个空行

（4）代码注释之前保留一个空行

（5）一个方法内的两个逻辑段之间有一个空行

3.2 空格

（1）“=”前后各有一个空格

（2）所有的二元运算符都应该用空格与操作数分开

a = c + d;

printf("size is " + foo + "/n");

（3）一元操作符：负号“-” 自减“--” 自增“++” 它们和操作符之间没有空格

int a = -b;

a--;

（4）小左括号 “（”之后，小右括号“）”之前，没有空格

a = (a + b) / (c * d);

（5）大左括号 “ { "之前有一个空格

while (a == d) {

n += 1;

};

（6）方法参数列表小左括号 “（” 之前没有空格，小右括号“）”之后有一个空格，参数列表中 “，” 之后也有一个空格；

String format(Object obj, StringBuffer toAppendTo, FieldPosition fieldPosition) {

........

}