📚 代码规范与最佳实践
命名规范
- 变量名使用
snake_case
(如variable_name
) - 类名使用
PascalCase
(如ClassName
) - 常量名全大写(如
MAX_VALUE
) - 函数名使用
snake_case
(如calculate_sum
)
- 变量名使用
缩进与空格
- 使用4个空格缩进,避免使用Tab
- 运算符两侧保留一个空格(如
x = 5
) - 逗号后加空格(如
x, y, z
)
注释与文档
- 关键逻辑需添加注释(
# 这是注释
) - 函数需写明参数说明(
def add(a, b): ...
) - 长代码块建议用
"""
包裹说明
- 关键逻辑需添加注释(
🧰 开发工具推荐
- IDE:推荐使用 PyCharm 或 VS Code
- 版本控制:强制使用 Git + GitHub(GitHub入门指南)
- 调试技巧:建议使用
print()
或pdb
模块
🌐 学习资源扩展
Python官方文档 是最权威的参考资料,包含语法、库文档和教程。
对于初学者,可优先阅读 Python基础教程