缩写

在编写代码时,应避免使用非标准或不常见的缩写,除非这些缩写在项目外也非常明了,如IOT、DNS、IP等。

  • 避免使用省略字母的缩写,例如将count写成cnt
  • 使用完整单词或广为人知的缩写,如password可以缩写为pwdusername可以缩写为usr

理由

  • 使用完整单词可以提高代码的可读性,特别是对于新团队成员或外部开发者。
  • 避免缩写可以减少误解和混淆,特别是在缩写不常见或不明确的情况下。
  • 广为人知的缩写(如pwdusr)因其普遍性和一致性而被接受。

不好示例

# 不推荐的函数命名
def get_cnt():
    return 0

推荐示例

# 推荐的函数命名
def get_cnt():
    return 0