标签：8.1 说明 Java 变量 代码 规范 注释 首字母

​

在学习和结对编程的过程中，大家编码的习惯不一定相同，导致交流上受到较大影响，于是学习整理了Java编写代码中的一些规范。

1.缩进

不用Tab键，应用四个空格。不同编辑器Tab会可能显示不同宽度。

2.行宽

80个字符。

超长的语句应该在一个逗号或者一个操作符后折行。一条语句折行后, 应该比原来的语句再缩进4个字符。

3.编码

使用UTF-8编码。

4.空行

相对独立的代码块之间应用空行隔开。

5.空格与括号

5.1空格：

为是使代码更加清晰，在对两个及以上成员进行一般运算符（+、-、*、/、%等）的对等操作时，在操作符前后加一个空格；但对于其他关系紧密的操作符，如“->”、小括号等。

逗号后不换行，紧跟一个空格。

5.2括号：

对于{}，大括号的开始在代码块开始的行尾，闭合在和代码块开头平行同一缩进的行首。

每个if、while、for都不要省略括号。

如：

for (int i = 0; i < 10; i++) {
    System.out.println(arg);
}

6.命名

6.1整体要求：统一，达意，简洁

6.2包名

   只有小写字母，用‘.’连接。

   通常可用所在单位的Internet域名的倒序，最后一个标识符说明该包的功能。

   如：

      package cn.***.***.organization

6.3类、接口

   Pascal：首字母大写，不同单词首字母大写作为分隔。

   如： SupplierService

6.4成员

   变量、方法：

     Camel：首字母小写，不同单词首字母大写作为分隔。

     如：addNewContract，size

   static final常量：

     全字母大写，不同单词用‘_’分隔。

     如：MAX_INDEX

6.5方法

   动宾结构，一般不同前缀表示不同含义。

   如getName()、setName()、addOrder()、removeOrder()等

6.6枚举

   文件名同类命名，成员同常量命名。

7.变量声明与作用域

7.1

变量声明应该尽量和变量使用放在一起，不能隔开太远。

7.2

尽量减少变量作用域。

能用局部变量的，不要使用实例变量；能用实例变量的，不要使用静态变量。变量的生存期越短，意味着它被误用的机会越小，同一时刻要关注的变量的状态也越少。实例变量和静态变量默认都不是线程安全的，局部变量是线程安全的。

8.注释

8.1文档注释：

/**   */

用来注释类、接口、方法、变量、常量

8.1.1类注释

/**
* @description 测试类
* @ClassName HelloWorld.java
* @author 。。。
* @Date   2021-9-25 00:00:00
* @version 1.00
*/

8.1.2属性注释

/** 字符串信息 */
private String strMsg = null;

 

8.1.3方法注释

/**
* 类方法的详细使用说明
* @param 参数1 参数1的使用说明
* @param 参数2 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

8.1.4构造方法注释

/**
* 构造方法的详细使用说明
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

8.2块注释：

/* */

用来注释文件头、算法实现、复杂代码块、修改记录

8.3行注释：

//

一般注释局部变量

​

标签：8.1,说明,Java,变量,代码,规范,注释,首字母
来源： https://www.cnblogs.com/Derek-cpp/p/15334278.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。