用这 16 个命名规则让你告别注释！

Android

2023-11-01 04:19:22

高效代码命名：告别冗长注释

作为一名程序员，我们经常面临为代码添加注释的苦恼。虽然注释对于代码理解很重要，但编写它们却是一项费时费力的工作。不过，通过掌握高效的代码命名技巧，我们可以大幅减少甚至告别冗长的注释。

何谓高效代码命名？

高效代码命名就是使用具有性、简洁、一致、有意义的名称来标识代码中的概念和对象。清晰的代码名称可以帮助开发者快速理解代码的意图，从而减少对注释的需求。

16 条高效代码命名规则

以下是 16 条帮助你高效命名代码的规则：

1. 使用性的名称

名称应该准确代码所代表的概念或对象。避免使用缩写、行话或模糊不清的词语。

2. 保持名称简洁

名称应该尽可能简洁，但又不失描述性。太长的名称会让人难以阅读和记忆。

3. 使用一致的命名约定

在整个项目中保持一致的命名约定非常重要。这将有助于提高代码的可读性和可维护性。

4. 使用驼峰命名法

驼峰命名法是一种命名约定，它将每个单词的首字母大写，除了第一个单词之外。例如： calculateTotalAmount()。

5. 使用下划线分隔单词

对于多单词名称，可以使用下划线来分隔单词。例如： calculate_total_amount。

6. 避免使用特殊字符

在名称中避免使用特殊字符，如： #、$、% 等。这些字符可能会导致语法错误或解析问题。

7. 使用有意义的缩写

如果必须使用缩写，请确保它们有意义且容易理解。例如： HTTP、JSON 等。

8. 避免使用负面词语

在名称中避免使用负面词语，如： not、no、never 等。这些词语会使代码难以阅读和理解。

9. 使用动词或名词

名称应该是动词或名词，具体取决于它所代表的概念或对象。例如： calculateTotalAmount()（动词）或 totalAmount（名词）。

10. 使用单数或复数

名称应该是单数或复数，具体取决于它所代表的概念或对象的个数。例如： calculateTotalAmount()（单数）或 calculateTotalAmounts()（复数）。

11. 使用大小写区分

大小写可以用来区分不同类型的名称。例如： calculateTotalAmount()（函数）和 TOTAL_AMOUNT（常量）。

12. 使用命名空间

命名空间可以用来组织和管理名称，防止名称冲突。例如： com.example.myapp.calculateTotalAmount()。

13. 避免使用匈牙利命名法

匈牙利命名法是一种过时的命名约定，它使用前缀来指示数据类型或变量作用域。例如： iTotalAmount。

14. 使用自解释的代码

编写自解释的代码，减少对注释的依赖。例如：

int totalAmount = calculateTotalAmount(order);

15. 使用文档生成器

文档生成器可以自动生成代码的文档，包括函数、类和模块的描述。这可以减少编写注释的手动劳动。

16. 编写单元测试

单元测试可以验证代码的正确性，从而减少对注释的需求。例如：

@Test
public void testCalculateTotalAmount() {
    Order order = new Order();
    order.addItem(new Item("Item 1", 100));
    order.addItem(new Item("Item 2", 200));
    int expectedTotalAmount = 300;
    int actualTotalAmount = calculateTotalAmount(order);
    assertEquals(expectedTotalAmount, actualTotalAmount);
}