编程之方法命名规范

作用

方法(函数)的命名非常重要,因为它直接反映了方法的行为和目的。

 

建议

1. 方法名通常以动词或动词短语开始,描述方法的行为,例如 calculateTotal, saveRecord, processData

2. 方法名应该尽可能简短,同时又能清晰地表达方法的功能。

3. 确保方法名不会与其他方法混淆,避免使用模糊或多义的词汇。

4. 尽可能使用具体的词汇来描述方法的行为,而不是过于通用的词汇。例如,calculateTax() 比 processNumbers() 更具体。

5. 如果方法需要参数,参数名应该清晰地表达其含义,并且方法名应该反映这些参数的使用。

6. 在命名方法时,考虑它在类中的作用和它与其他方法的关系。

7. 在整个项目中保持一致的命名约定。

8. 布尔方法通常以 ishascanshould 等词开头,以表明它们返回一个布尔值。

命名方法

java: 

  • 方法和变量名使用小驼峰命名法(camelCase),例如 calculateTotal

python:

  • 函数和变量名使用小驼峰命名法,例如 calculate_total
  • 受保护的实例属性以下划线和一个小写字母开头,例如 _internal_variable

 

posted @ 2024-09-17 21:22  zzl14  阅读(178)  评论(0)    收藏  举报