Java 中的编码指南

Java 是最流行和广泛使用的面向对象编程语言。它为开发人员提供了开发各种应用程序的平台，如 Web、桌面应用程序、游戏等。使用 Java 编程语言的原因是它提供了安全性、可靠性，而且速度快。用 Java 编写代码有点困难，因为它遵循许多规则和指南，我们必须遵循这些规则和指南才能获得更好的可读性。

什么是编码规范？

在 Java 中，编码规范是开发人员在应用程序开发过程中遵循的一组规则。这些指南为处理该项目的其他开发人员和用户提供了可读性。必须遵循这些指南，因为应用程序不是由单个程序员开发的。一些主要的编码规范包括以下内容：

• 命名约定
• 花括号
• 缩进
• 空格
• 注释

命名约定

这些是命名变量、方法、常量、类、接口等的规则。通常，Java 遵循驼峰命名法。它描述了以下内容：

• 类名和接口名应该是名词，每个内部单词的首字母都应该大写。
• 方法名应该是混合大小写的动词，每个首字母都应该是小写，每个内部单词的首字母都应该大写。
• 所有常量都应该是大写字母。
• 变量名必须是一个有意义的字母或单词。

花括号

花括号的使用在编程中非常重要。它定义了类、方法和循环的主体。花括号的两种标准用法如下：

• 在花括号的开始之后和结束之前不应该有空行。
• 花括号应用于表示类、方法和循环开始的行末。结束花括号应垂直对齐在开始花括号所在的位置。结束花括号应放在单独的一行（新行）上。例如，考虑以下循环。

• 每个花括号都放在新行上，并且花括号对垂直对齐。上面的代码片段可以写成如下：

缩进

缩进应为 4 个空格。按 Tab 键，我们会得到 8 个空格。缩进可以通过空格字符和制表符来实现。

为了提高每行可读性的公认标准是：

• 对垂直列表中的相同项目（例如行尾注释和声明中的标识符）应用缩进。
• 在二进制运算符（包括赋值）周围加上空格。
• 在分号或逗号后面加上一个空格。
• 在两个关键字（如“if”、“while”、“return”、“catch”、“switch”、“for”）和后面的括号之间留一个空格。
• 多余的括号有助于突出表达式的结构。但我们应该避免过多的嵌套括号，因为它可能导致错误。
• 最好留一个额外的空行来区分重要的代码块。让我们在代码中实现所有上述指南：

空格

它在程序的读性方面也起着至关重要的作用。任何数学运算（+、-、*、% 等）都应该用空格包围。例如：

Java 中保留的关键字后面必须跟空格。例如：

总是在逗号后面放一个空格。这意味着逗号后面必须跟一个空格。

冒号应该用空格包围。例如，case 语句必须这样写：

for 语句中的分号后面应该跟一个空格。例如：for 循环必须这样初始化：

注释

编程中的注释非常重要，因为它提高了程序的可读性。它包含有关程序的相关信息。请注意，注释会被编译器忽略。

我们为什么要使用注释？

• 注释用于通过添加代码的详细信息来提高程序的可读性。
• 这使得代码易于维护，并且可以轻松找到错误。
• 注释可用于提供有关变量、方法、类或任何语句的信息或解释。
• 它也可以在测试替代代码时用于阻止程序代码的执行。

Java 提供了两种类型的注释：

• 单行
• 实施
• 块
• 尾注

实施

它也以两个正斜杠开头。Java 还允许我们使用 /**/ 进行注释。如果我们不想执行一段代码，可以使用它。有四种实现的注释类型：

块、单行、尾注和临时移除代码。

块注释

块注释提供了对方法、数据结构和算法的描述。通常，它用于文件开头、方法之前或方法内部。在块注释开始之前必须有一个空行，除非它紧跟在复合语句开始之后。

单行

单行注释用于注释代码的单行。它是注释语句最常用和最简单的方法。

单行注释以两个正斜杠（//）开头。当注释无法写在一行时使用它。// 前面的任何文本都不会被 Java 执行。

尾注

尾注（短注释）是可以写在同一行上的注释，但应与代码保持一定距离。如果出现多个短注释，它们都应缩进到相同的制表位。例如：

例如

临时移除代码

它用于注释部分或全部代码行。我们也可以在多行注释中使用它。请注意，仅在代码开发过程中使用，并且我们想要移除特定代码块时使用。未使用的代码最终应被物理删除，因为它会使源代码更难维护。例如：

文档注释

文档注释通常用于为项目或软件应用程序编写大型程序，因为它有助于创建文档 API。这些 API 需要引用，即代码中使用了哪些类、方法、参数等。

要创建文档 API，我们需要使用 javadoc 工具。文档注释放在 /** 和 */ 之间。

语法