本节将详细介绍我们的代码规范,以确保代码质量和可维护性。
语言风格
- 中文: 如果您访问的是 /Documentation/Code_Standards_Details/zh ,则会显示中文内容。
- 英文: 如果您访问的是 /Documentation/Code_Standards_Details/en ,则会显示英文内容。
核心原则
- 命名规范:变量、函数和类名应使用驼峰命名法(camelCase)。
- 代码格式:使用四个空格缩进,而非制表符。
- 注释:代码应包含必要的注释,以解释复杂逻辑或设计决策。
- 代码复用:尽可能复用代码,减少重复。
示例
def calculate_area(width, height):
"""计算矩形面积
Args:
width (int): 宽度
height (int): 高度
Returns:
int: 面积
"""
return width * height
扩展阅读
想要了解更多关于代码规范的信息,请访问代码规范总览。
图片示例
Python 图标
代码示例