TensorFlow 文档团队遵循一套严谨的编码标准,以确保代码质量与一致性。以下是核心规范要点:

  • 代码风格
    采用 Python PEP8 规范,关键点包括:

    • 缩进使用 4 个空格
    • 变量名遵循 snake_case
    • 函数参数类型注解(如 def my_function(param: int) -> str:
    Python_PEP8
  • 文档规范
    所有文档需包含:

    • 中英文双语支持(路径 /en/xxx 时自动切换)
    • 代码块使用 ```python 包裹
    • 图片需标注清晰来源(如 TensorFlow_logo
    TensorFlow_logo
  • 测试要求
    每个功能需配套单元测试,使用 unittest 框架:

如需深入了解 TensorFlow 文档开发流程,可参考 官方开发指南

documentation_guidelines