欢迎贡献文档到 TensorFlow 项目!请遵循以下风格规范以确保一致性与可读性:
代码格式化 🧠
- 使用 Python 3 语法,代码块需用 ```python 包裹
- 保持 4 空格缩进,避免 TAB 字符
- 函数注释需包含参数说明(
:param
)和返回值(:return
) - 示例代码应包含
<center><img src="https://cloud-image.ullrai.com/q/代码格式化/" alt="代码格式化"/></center>
术语使用 🗣️
- 技术术语需保持英文原词(如
tf.function
) - 概念解释需用中文,并附英文对照
- 避免使用过时 API 名称,优先使用最新文档中的术语
- 术语表可参考:
结构清晰 📚
- 每个章节需有明确标题(使用
##
级别) - 列表项使用
-
或1.
格式 - 重要提示用
⚠️
标记 - 文档结构示例:
贡献流程 🛠️
⚠️ 注意:所有文档需通过 文档检查工具 验证后方可合并