Java高级程序设计第1章Java编码规范：编码的重要性及其相关知识

Java 高级程序设计第 1 章为 Java 编码规范。其中包含 1.1 应用场景、1.2 相关知识、1.3 任务实施、1.4 拓展知识、1.5 拓展训练以及 1.6 课后小结。在一个大型软件项目中，它是由一个团队来完成的。每个程序员在给包、类、变量、方法取名时，如果没有约定，只是随意取名，可能会引发一系列问题。程序编码需要遵循编码规范，这样能保证代码的正确性、稳定性和可读性。规范编码具有以下作用：其一，规范的代码有利于促进团队合作；其二，规范的代码能够减少 bug 处理；其三，规范的代码可以降低维护成本；其四，规范的代码有助于进行代码审查；其五，养成代码规范的习惯，有助于程序员自身的成长。1.2 相关知识，1.2.1 文件后缀。

名 1.2.2 规定了源文件的样式，1.2.3 明确了注释的规范，1.2.4 确定了命名的规范，1.2.1 规定了文件的后缀名。表 1-1 展示了 Java 程序使用的文件后缀名。其中，两者最本质的区别在于，.Java 文件是供虚拟机运行时执行的文件，而.class 文件可以在任何安装了 Java 虚拟机的机器上运行。3. 类和接口声明。包和引入语句 package 行需处于 import 行之前，在 import 中，标准的包名要位于本地的包之前。

名在之前，并且按照字母顺序进行排列。倘若 import 行里包含了同一包中的不同子目录，那就应当用 * 来进行处理。类和接口有声明，每个 Java 源文件都包含一个单一的公共类或接口。注释编写有原则，（1）注释形式需统一，在整个应用程序中，要使用具有一致标点和结构的样式来构造注释。如果在其他项目里发现它们的注释规范和这份文档不一样，那就按照这份规范来写代码，别想着在已有的规范系统里添加新的规范。注释内容要做到准确且简洁，内容需简单、明了且含义准确，要避免注释出现多义性，错误的注释不但没有益处反而会有坏处。 - 构造函的注释。

数需加注释；方法需加注释；全局变量需加注释；字段/属性需加注释。简单代码做简单注释，不超 10 字。持久化或 VO 对象的 getter、setter 方法不加注释。特殊必加注释：典型算法必加，代码不明晰处必加。在代码修改的地方加上带有修改标识的注释。在由循环和逻辑分支构成的代码中添加注释。为他人提供的接口一定要加上详细的注释。注释的格式有两种，其一，单行注释的格式是“/”；其二，块注释的格式是“/*/”。并且要求注释的内容既准确又简洁。（3）文档注释格式为“/*/”。（4）Javad

- exception 用于对方法进行说明，是对方法可能抛出的异常进行说明。命名规范中，命名涵盖系统内对包名、目录（类名）、方法、常量、变量等标识符的命名。这些标识符的命名要努力做到统一、达意且简洁，同时遵循驼峰法则。统一意味着对于同一个概念，在程序中需使用同一种表示方法。比如对于供应商，既可以用“supplier”，也可以用“provider”，但

我们在一个 Java 项目中只能选定一种标识符的使用方式，并且要保持统一。达意意味着标识符能够准确地表达出它所代表的意义，像 newSupplier、OrderPaymentGatewayService 等就是符合要求的；然而 supplier1、service2、idtts 等就不是好的命名方式。简洁意味着，在能够统一和表达意思的前提下，要使用尽可能少的标识符。倘若无法表达意思，那就宁可不要过于简洁。请提供需要改写的句子呀，没有看到具体的内容呢。驼峰法则意味着单词之间不借助特殊符号进行分割，而是依靠首字母大写来实现分割。比如推荐使用 SupplierName 和 addNewContract，而非 supplier_name 和 add_new_contract。（1）任务需求：某公司划分有多个部门，每个部门都配备有一个经理以及多个员工，每位员工依据其职称来领取基本工资。