社区代码风格指南旨在确保我们的代码库保持一致性、可读性和可维护性。以下是我们推荐的编码规范。

语言风格

  • 中文：本指南适用于中文编码风格。
  • English：This guide is for English coding style.

命名规范

  • 变量和函数名使用小写字母，单词之间使用下划线分隔。
  • 类名使用大驼峰命名法（PascalCase）。
  • 常量使用全大写字母，单词之间使用下划线分隔。

注释

  • 使用简洁明了的注释来解释代码的功能。
  • 在复杂的逻辑或算法中添加注释。
  • 避免不必要的注释。

代码格式

  • 使用4个空格进行缩进。
  • 每行代码不超过80个字符。
  • 使用单行或双行括号。

示例代码

def add(a, b):
    """计算两个数的和"""
    return a + b

if __name__ == "__main__":
    print(add(1, 2))

扩展阅读

更多关于代码风格的信息，请参考本站代码风格指南。

Python