干净代码的特征

程序员或开发人员通常为他们的项目或某些公司编写代码。或者有些人作为编程世界的初学者开始编写代码。在所有这些场景中，当您在很长一段时间后重新访问您的代码时，就会有一种怀旧的时刻。你会发现自己的代码很难理解。以下是您应该遵循的一些良好实践或干净代码的特征：

1.命名约定：这是一个非常基本的做法。正确命名变量和函数非常重要。假设有人要检查您的代码，那么他/她应该一眼就能理解代码。

应该根据项目域命名变量。
应该使用“is”作为布尔变量的前缀。

示例：假设您正在创建一个银行应用程序或与支付有关的东西。

double totalBalance;        // Represents the user account balance

double amountToDebit;      // Represents the amount to charge the user

double amountToCredit;    // Represents the amount to give to the user

boolean isUserActive;

必须遵循：

变量和数据结构的骆驼案例。

例子：

String  merchantName = "John Perry";

int  integerArray[] = new int[10];

常数的尖叫蛇案例。
例子：
```
final long ACCOUNT_NUMBER = 123456;
```

2.一切都与方法/功能有关

“The more useful methods you write the better coder you are”
– Mitch Tabian, CodingWithMitch

编程需要懂一点英语

使用 Camel Case 命名函数。
命名动词-名词发音上的功能。
方法的左括号必须与方法名称在同一行。
函数应该只接受 1 或 2 个不超过该参数的参数。

例子：

double getUserBalance(long int accountNumber) {

// Method Defination

}

3. 文件结构：维护项目的结构非常重要。这使它非常干净，更容易理解。结构从 Web 开发到移动开发不同，但想法保持不变。

例子：

4. 缩进：有时你写了一些代码，而这些代码是在另一个代码中组成的，或者你可以说是嵌套代码。这种构图很难分类，区分也不容易。所以最好使用缩进。这意味着将括号放在正确的位置。

5. 日志记录：当涉及到编写代码时，并不意味着您只是编写代码并成功编译。总有一天或很多次您将不得不进行调试，这与事实相去甚远。编写日志语句可以帮助您度过那些可怕的时刻。在函数中编写日志语句是一个不错的选择。大多数处理是通过函数完成的，因此在那里有一个日志语句意味着我们可以获得成功和失败的指示。

6. 避免不言自明的注释：我们都喜欢在代码周围添加注释。在重要的一点上，我们应该避免那些不言自明的评论，因为它既费时又无用。应该编写能够自我解释的代码。

例子：

final double PI = 3.14; // This is pi value //

上述声明的评论是不必要的。所以避免这种做法。