Appearance
代码标注规范 v2
用统一符号标注代码中不理解的部分,支持分类,方便后续聚类复习。
标注符号
| 符号 | 含义 | 示例 |
|---|---|---|
❓[语法] | 不懂这个语法 | ❓[元组拆包](a, b) = func() |
❓[概念] | 不懂这个概念 | ❓[概念] 什么是张量 |
❓[库] | 不懂某个库的用法 | ❓[库] tf.keras.datasets |
⚠️ | 知道是什么,但不确定用法 | ⚠️ f-string 用法细节 |
🔗 | 和某处知识有关联 | 🔗 见 L1 元组拆包 |
✅ | 已理解 | ✅ 已掌握 print 用法 |
分类标签(方括号标注)
| 标签 | 含义 |
|---|---|
[语法] | Python 语法相关(拆包、推导式、装饰器等) |
[概念] | 通用计算机概念(张量、线程、异步等) |
[库] | 第三方库用法(TensorFlow、Pandas 等) |
[API] | 函数/模块的接口调用 |
[数据类型] | 数据结构相关(list、dict、ndarray 等) |
使用方法
1. 代码中标注
Python
# 标注 + 分类
❓[语法] from tensorflow.keras.datasets import mnist
❓[语法] (train_images, train_labels), (test_images, test_labels) = mnist.load_data()
❓[概念] 什么是张量(Tensor)
❓[库] tf.keras.datasets 是用来做什么的
Click Run to see output
2. 复习笔记模板
markdown
# ❓ 知识盲点清单
## ❓[语法] 元组拆包
- **来源:** L1 MNIST 数据加载
- **代码:** `(a, b), (c, d) = func()`
- **状态:** ✅ 已解答
- **简答:** 外层先拆,再内层拆,嵌套结构用嵌套拆包接收
- **链接:** [L1 教程](/tutorial/begin)
---
## ❓[概念] 张量(Tensor)
- **来源:** TensorFlow 文档
- **状态:** 🔄 进行中
- **疑问:** 张量和 Numpy 数组有什么区别?
- **计划:** 查 L1 扩展资料聚类复习方法
按标签聚合
每学完一个阶段,把相同标签的 ❓ 归类:
markdown
## [语法] 类 — 语法类盲点汇总
1. 元组拆包 ✅(L1)
2. f-string 格式化 ✅(L2)
3. *args **kwargs 🔄(L4)
## [库] 类 — 库用法类盲点汇总
1. tf.keras.datasets 🔄(L1)
2. tf.data.Dataset 🔄(L5)复习优先级
| 优先级 | 条件 | 行动 |
|---|---|---|
| 🔴 高 | ❓ + [语法] | 优先解决,影响后续学习 |
| 🟡 中 | ❓ + [库] | 边用边查,结合文档 |
| 🟢 低 | ⚠️ + [概念] | 理解即可,不影响编码 |
示例:L1 标注记录
代码中的标注
Python
# L1 代码示例
print("hello") # ✅ 理解
❓[语法] (a, b), (c, d) = nested_tuple() # 嵌套拆包
❓[库] from tensorflow.keras.datasets import mnist # 导入语法
Click Run to see output
标注笔记
markdown
## ❓[语法] 嵌套元组拆包
- **代码:** `(train_images, train_labels), (test_images, test_labels) = mnist.load_data()`
- **状态:** ✅ 已解答
- **简答:** 分层拆解,先外层后内层
- **同类延伸:** 普通拆包 `(a, b) = func()`推荐流程
遇到不懂的代码
│
▼
标注 ❓[类别] + 写疑问
│
▼
学完一课 / 一个章节
│
▼
归类同一标签的 ❓ → 形成「[语法]类」「[库]类」清单
│
▼
按优先级逐个击破 → 解答后改为 ✅这样复习时按类别翻,比散着看效率高很多 👍