TensorFlow 的代码风格指南旨在确保项目可读性、一致性和可维护性。以下为关键规范：

1. 命名规范

  • 变量与函数：使用 snake_case，例如 model_weights 或 train_model()
  • 类名：使用 CamelCase，例如 NeuralNetwork
  • 常量：全大写加下划线，例如 MAX_ITERATIONS

2. 代码结构

  • 模块应包含清晰的注释块（以 # 开头）
  • 使用 tf.Module 作为基类，避免直接继承 object
  • 保持函数参数数量 ≤ 5，避免嵌套过深

3. 格式与风格

  • 缩进：4 个空格（不使用 Tab）
  • 行长度：≤ 79 字符（超长时用 \ 换行）
  • 导入语句：按顺序分组（标准库、第三方库、本地模块）

4. 注释与文档

  • 函数需包含 docstring（使用 """ 包裹）
  • 关键逻辑添加 # TODO 或 # FIXME 标记
  • 避免冗余注释，注释应解释“为何”而非“何为”

5. 扩展阅读

如需深入了解，可参考 TensorFlow 官方编码规范 获取完整文档 📚

TensorFlow_编码规范

📌 提示：遵循此指南能显著提升团队协作效率，同时减少因风格差异导致的代码冲突。