Java编程风格规范

Java编程风格规范

目录

目录 .................................................................................................................................................. 1 一、

1 2 二、

1 2 3 三、

1 2 3 4 四、

前言 ................................................................................................................................... 3 术语说明 ........................................................................................................................... 3 规范说明 ........................................................................................................................... 3 源文件基础 ....................................................................................................................... 4 文件名 ............................................................................................................................... 4 文件编码：UTF-8 ............................................................................................................. 4 特殊字符 ........................................................................................................................... 4 源文件结构 ....................................................................................................................... 6 许可证或版本信息 ........................................................................................................... 6 package语句 .................................................................................................................... 6 import语句 ...................................................................................................................... 6 类声明 ............................................................................................................................... 7 格式 ................................................................................................................................... 8

1 大括号 ............................................................................................................................... 8 2 块缩进：4个空格 .......................................................................................................... 10 3 4 5 6 7 8 五、

1

一行一个语句 ................................................................................................................. 10 列限制：160字符 .......................................................................................................... 10 自动换行 ......................................................................................................................... 11 空白 ................................................................................................................................. 12 用小括号来限定组：推荐 ............................................................................................. 14 具体结构 ......................................................................................................................... 15 命名约定 ......................................................................................................................... 19 对所有标识符都通用的规则 ......................................................................................... 19

2 3 六、

1 2 3 4 5 6 七、

1 2 3

标识符类型的规则 ......................................................................................................... 19 驼峰式命名法(CamelCase) ............................................................................................. 21 编程实践 ......................................................................................................................... 23 @Override：能用则用 ................................................................................................... 23 捕获的异常：不能忽视 ................................................................................................. 23 静态成员：使用类经行调用 ......................................................................................... 23 Finalizers：禁用 ......................................................................................................... 24 源文件和方法：代码行数限制 ..................................................................................... 24 其它：建议 ..................................................................................................................... 24 Javadoc ........................................................................................................................... 25 格式 ................................................................................................................................. 25 摘要片段 ......................................................................................................................... 25 哪里需要使用Javadoc .................................................................................................. 26

八、 参考 ................................................................................................................................. 27

一．前言

这份文档是Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的规则， 我们才认为它符合Java编程风格。与其它的编程风格规范一样，这里所讨论的不仅仅是编码格式美不美观的问题， 同时也讨论一些约定及编码标准。然而，这份文档主要侧重于我们所普遍遵循的规则， 对于那些不是明确强制要求的，我们尽量避免提供意见。

1.1 术语说明

在本文档中，除非另有说明：

1.术语class可表示一个普通类，枚举类，接口或是annotation类型(@interface) 2.术语comment只用来指代实现的注释(implementation comments)，我们不使用“documentation comments”一词，而是用Javadoc。 其他的术语说明会偶尔在后面的文档出现。

1.2 规范说明

本文档中的示例代码遵循Java编程风格，但并不意味着这是展现这些代码的唯一方式。对于可以有不同风格编写的会给予说明，但大家达成共识的格式和官方默认建议使用的格式，务必遵守。

二．源文件基础 2.1 文件名

源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为.java。即如果类是public的，最顶层的类应该是public。

2.2 文件编码：UTF-8

源文件编码格式为UTF-8。

2.3 特殊字符

2.3.1 空白字符

除了行结束符序列，ASCII水平空格字符(0x20，即空格)是源文件中唯一允许出现的空白字符，这意味着：所有其它字符串中的空白字符都要进行转义。

2.3.2 特殊转义序列

对于具有特殊转义序列的任何字符(\\b, \\t, \\n, \\f, \\r, \\“, \\‘及\\)，我们使用它的转义序列，而不是相应的八进制(比如\\012)或Unicode(比如\)转义。

2.3.3 非ASCII字符

对于剩余的非ASCII字符，是使用实际的Unicode字符(比如∞)，还是使用等价的Unicode转义符(比如\∞)，取决于哪个能让代码更易于阅读和理解。

建议: 在使用Unicode转义符或是一些实际的Unicode字符时，建议做些注释给出解释，这有助于别人阅读和理解。 示例：

String unitAbbrev = \μs\ | 赞，即使没有注释也非常清晰 String unitAbbrev = \ // \μs\允许，但没有理由要这样做

String unitAbbrev = \// Greek letter mu, \允许，但这样做显

得笨拙还容易出错

String unitAbbrev = \ | 很糟，读者根本看不出这是什么

建议: 永远不要由于害怕某些程序可能无法正确处理非ASCII字符而让你的代码可读性变差。当程序无法正确处理非ASCII字符时，它自然无法正确运行， 你就会去fix这些问题的了。(言下之意就是大胆去用非ASCII字符，如果真的有需要的话)

本文来源：https://www.bwwdw.com/article/akzd.html