欢迎查阅 TensorFlow 社区的代码风格规范！本指南旨在帮助开发者遵循一致的编码标准，提升代码可读性与协作效率。以下是核心规范要点：
📌 Python 代码风格
- 缩进：使用 4 个空格（不推荐 Tab）
- 行长度：单行不超过 79 个字符，超长时用反斜杠
\换行 - 空格：运算符两侧需空格（如
x = y + 1），逗号后空格（如args, kwargs）
示例：
def example_function(arg1, arg2):
"""示例文档字符串"""
result = arg1 * arg2 # 正确：运算符两侧有空格
return result
🧾 命名规范
| 类型 | 建议格式 | 示例 |
|---|---|---|
| 变量 | snake_case |
model_weights |
| 函数 | snake_case |
calculate_loss |
| 类 | PascalCase |
NeuralNetwork |
| 常量 | UPPER_SNAKE_CASE |
MAX_EPOCHS |
⚠️ 注意：避免使用单字符变量名（如 x），除非在循环索引中。
📝 注释与文档
- 函数需包含文档字符串（docstring），使用三重引号
- 关键逻辑段落添加注释，避免过度注释
- 使用中文注释时保持简洁专业（例如：
# 初始化优化器）
扩展阅读：TensorFlow 官方文档 提供更详细的开发规范
🧪 代码格式化工具
# 安装 Black
pip install black
# 格式化代码
black your_file.py