本文档旨在为开发者提供统一的代码书写规范,建议结合贡献指南阅读以获取更完整的开发规范体系。
命名规范 🧾
- 变量名:使用小写字母与下划线分隔,如
user_name
- 函数名:动词开头,驼峰命名法
calculateTotal()
- 常量名:全大写加下划线
MAX_LIMIT
- 类名:帕斯卡命名法
UserManager
格式规范 📝
- 缩进使用 4个空格 或 Tab键
- 每行最大长度不超过 80字符
- 代码块使用 ```markdown 包裹
- 三引号
"""
用于多行字符串
注释规范 📖
- 函数注释应包含用途、参数、返回值
- 关键代码需添加说明性注释
- 避免冗余注释(如
i++
不需要注释)
代码示例 📜
def add(a: int, b: int) -> int:
"""计算两个整数的和
Args:
a (int): 第一个加数
b (int): 第二个加数
Returns:
int: 两个数的和
"""
return a + b
查看完整规范文档以获取更多细节