Java编码指南

Java是最流行和广泛使用的编程语言和平台之一。平台是有助于开发和运行以任何编程语言编写的程序的环境。 Java快速、可靠且安全。从桌面到 Web 应用程序，从科学超级计算机到游戏机，从手机到 Internet， Java被用于每个角落。

在本文中，让我们了解一些有助于提高程序可读性的编码指南。

为什么是编码指南？

编码指南很重要，因为大部分软件成本都用于维护。而且，该软件并不总是由单个开发人员开发。因此，保持编写软件的惯例会增加程序的可读性。

一些指导方针是：

1.命名约定：我们在Java编程中一般遵循驼峰式约定。这意味着所有的类和接口都应该是名词，在混合情况下，每个内部单词的首字母大写。所有方法都应该是动词，混合大小写，首字母小写，每个内部单词的首字母大写。变量应该是有意义的，并且必须避免使用一个字符的变量名称。常量变量在大写情况下定义。

2. 花括号：花括号用于定义类、方法和循环的主体。花括号的使用有两种标准格式，可以使用其中的任何一种。

在左大括号之后或右大括号之前不应出现空行。
花括号应用于开始类、方法、循环等的行的末尾，而右花括号单独在一行上，与第一行的开头垂直对齐。例如：

class Geeksforgeeks {
   ... Geeksforgeeks(){
    // Constructor
       ...
   }

   int Geek(int a, float b){
   
       ... for (int i = 0; i < Field; i++){
           ....
       }
   }
}

每个花括号都添加到一个新行上，并且这对花括号垂直对齐。这种格式的前面的代码片段如下：

class Geeksforgeeks  
{
   ... Geeksforgeeks()
   { // Constructor
       ...
   }
   int Geek(int a, float b)
   {
       ... for (int i = 0; i < Field; i++)
       {
           ....
       }...;
   }
}

3、缩进：缩进的单位为4个空格。制表位应每 8 个空格准确设置一次。所有缩进必须由空格字符来实现，并且在生成的源文件中不能存在制表字符。提高每行可读性的公认标准是：

对垂直列表中的类似项目应用缩进（例如行尾注释和声明中的标识符）。
用空格包围二元运算符（包括赋值）。
分号或逗号后跟一个空格。
在关键字（“if”、“while”、“return”、“catch”、“switch”、“for”）和后面的括号之间添加一个空格。
多余的括号还可以帮助突出表达式的结构（但要避免使用过多的嵌套括号）。
插入空行以区分代码的重要部分。
让我们在代码中实现上述所有准则：

class Geeksforgeeks {
   private int s;
   private double d;

   Geeksforgeeks()
   { // Constructor
       s = 1;
       d = 3.14;
   }

   int Geek(int a, float b)
   {
       // Must initialize local variables
       int l = 0;
       float le = 1;
       int n = 10;
       l = n - 2;
       le = l + b * 3;

       for (int i = 0; i & lt; n; i++) {
           l = l * 2;
           l = l - n;
       }
       return l + a;
   }
}

4.空白：空白在可读性方面也起着重要作用，如下所示：

运算符应该被一个空格字符包围。例如：

The operation should be written as:
a = (b + c) * d;
And not as:
a=(b+c)*d

编程需要懂一点英语

Java的保留字后面应该有空格。例如：

The loop must be initialized as:
while (true) {…}
And not as:
while(true){…}

编程需要懂一点英语

逗号后面应该跟空格。例如：

The functions must be initialized as:
fun(a, b, c, d);
And not as:
fun(a, b, c, d);

编程需要懂一点英语

冒号应该被空白包围。例如：

The case statements must be initialized as:
case 100 : break;
And not as:
case 100:break;

编程需要懂一点英语

for 语句中的分号后面应该跟一个空格字符。例如：

The for loop must be initialized as:
for (i = 0; i < n; i++)
And not as:
for(i=0;i

编程需要懂一点英语

5.注释： Java程序可以有两种类型的注释。它们是实施和文档。注释应仅包含与阅读和理解程序相关的信息。例如，关于如何构建包或它所在目录的信息不应作为注释包含在程序中。

实施注释：实施注释由//分隔。 Java还允许使用 /*…*/ 来表示实现注释。实现注释用于关于特定实现的注释或临时删除代码。程序可以有四种风格的实现注释：块、单行、尾随和临时删除代码。
块注释用于提供文件、方法、数据结构和算法的描述。块注释可以用在每个文件的开头、每个方法之前或方法内。方法中的块注释应该缩进到与它们描述的代码相同的级别。块注释在其开始之前应该有一个空行，除非它紧跟在复合语句的开始之后。例如：

// block comment on line 1
// block comment on line 2
// block comment on line 3

编程需要懂一点英语

单行注释可以出现在缩进到后面代码级别的单行上。如果注释不能写在一行中，则应遵循块注释格式。单行注释之前应该有一个空行，除非它紧跟在复合语句的开始之后。例如：

a = 10;
b = 20;
// a single-line comment
c = a * b;

编程需要懂一点英语

尾随（非常短的）注释可以出现在它们描述的代码的同一行，但应该与代码分开很远的距离。如果一段相关代码中出现多个简短注释，则它们都应缩进到相同的选项卡设置。例如：

if (a == 2) {
   b = true; // special case
}
else {
   c = isPrime(x); // works only for odd
}

临时删除代码： // 分隔符可以注释掉部分或完整的行。它也可以在多行中用于注释掉整个代码段。需要注意的是，这只能在代码处于积极开发阶段时临时使用；未使用的代码最终应该被物理删除，因为它会使源代码更难维护。例如：

if (a > 1) {
b = a; // + 1;
...
}
else {
// b = 2;
...
}

文档注释：文档注释描述Java类、接口、构造函数、方法和字段。它们由/**…*/分隔。请注意开头的双星号 (**)，每个类、接口或成员都有一个注释。这个注释应该出现在声明之前，注释和它引用的代码之间没有空格。可以使用javadoc工具将文档注释提取到 HTML 文件中。可以在一行中指定类成员的 Javadoc，如下所示：

/** This is a java documentation comment */
private int comments_;

编程需要懂一点英语

文档注释旨在从无实现的角度描述代码的规范，以供可能不一定手头有源代码的开发人员阅读。 Java将文档注释与注释后的第一个声明相关联。因此，文档注释不应出现在方法或构造函数定义块中。例如：

虽然我们可以说上述指南不是确定性的，它们是相对的，但始终倾向于维护这些指南，因为该软件从来不是由一个人开发的，也可能不是由开发该软件的同一团队维护的。软件。为了解决软件中的任何错误，部署的代码必须易于阅读。遵循上述指导原则不仅可以让开发人员阅读代码，而且让第一次阅读代码的新人也可以阅读。