欢迎查阅 TensorFlow 文档的编写规范!以下是核心指导原则:
📌 基本规范
语言统一:使用中文描述,代码块保留英文关键字
代码格式:
# 示例代码 model = tf.keras.Sequential([ tf.keras.layers.Dense(64, activation='relu', input_shape=(784,)) ])
注释要求:
- 方法注释需包含参数说明
- 关键逻辑需添加
TODO
标记 - 错误处理建议使用
⚠️
Emoji
📁 文档结构
- 引言部分(需包含 📘 图标)
- 代码示例(建议添加 🧪 Emoji)
- 常见问题(推荐使用 ❓ 图标)
- 参考链接(必须包含 📚 图标)
🧠 编写建议
- 使用
##
标记子标题 - 重要提示建议添加
> 注意:...
- 示例代码需标注版本号:
// tensorflow:2.12
了解更多请访问 TensorFlow 官方文档:/tensorflow_docs/tutorials