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 个空格准确设置一次。所有缩进必须由空格字符来实现,并且在生成的源文件中不能存在制表字符。提高每行可读性的公认标准是:
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
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;
The for loop must be initialized as:
for (i = 0; i < n; i++)
And not as:
for(i=0;i
5.注释: 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;
...
}
/** This is a java documentation comment */
private int comments_;
文档注释旨在从无实现的角度描述代码的规范,以供可能不一定手头有源代码的开发人员阅读。 Java将文档注释与注释后的第一个声明相关联。因此,文档注释不应出现在方法或构造函数定义块中。例如:
虽然我们可以说上述指南不是确定性的,它们是相对的,但始终倾向于维护这些指南,因为该软件从来不是由一个人开发的,也可能不是由开发该软件的同一团队维护的。软件。为了解决软件中的任何错误,部署的代码必须易于阅读。遵循上述指导原则不仅可以让开发人员阅读代码,而且让第一次阅读代码的新人也可以阅读。