|
@@ -339,30 +339,28 @@ git commit -m "<类型>: <摘要>"
|
|
|
|
|
|
|
|
## 8. 代码整合规范
|
|
## 8. 代码整合规范
|
|
|
|
|
|
|
|
-### 8.1 两层级结构
|
|
|
|
|
|
|
+### 8.1 核心理念
|
|
|
|
|
|
|
|
-```
|
|
|
|
|
-code/ # 第一层:完整工程归档(只存不改)
|
|
|
|
|
-├── 09_消息队列/
|
|
|
|
|
-│ └── Core/Src/freertos_demo.c
|
|
|
|
|
|
|
+**不复制完整工程,只嵌入核心完整示例到笔记正文中。**
|
|
|
|
|
|
|
|
-07-消息队列与队列集.md # 第二层:嵌入提取的核心代码
|
|
|
|
|
|
|
+```
|
|
|
|
|
+原始代码项目 (外部路径) ← 源文件不动
|
|
|
|
|
+ │
|
|
|
|
|
+ ▼
|
|
|
|
|
+07-消息队列与队列集.md ← 笔记中嵌入提取的核心代码
|
|
|
|
|
+ └─ void task1(void *pvParameters) { ... }
|
|
|
|
|
+ └─ void task2(void *pvParameters) { ... }
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-- **`code/`** — 原始工程完整复制,作为可编译参考
|
|
|
|
|
-- **`.md` 笔记** — 从 `freertos_demo.c` 中提取**核心完整示例**,嵌入文档正文中
|
|
|
|
|
-
|
|
|
|
|
-### 8.2 嵌入原则
|
|
|
|
|
-
|
|
|
|
|
-**不要直接复制整个文件到笔记中**。提取核心示例时:
|
|
|
|
|
|
|
+### 8.2 嵌入步骤
|
|
|
|
|
|
|
|
-1. 读 `freertos_demo.c`(或 `main.c`)找到核心演示逻辑
|
|
|
|
|
-2. 提取完整的函数/代码块作为示例(可独立运行理解)
|
|
|
|
|
-3. 删除重复的模板代码(任务配置宏定义、启动调度器等通用部分只写一次)
|
|
|
|
|
-4. 每段代码必须有**通俗解释**(举生活中例子)
|
|
|
|
|
|
|
+1. 读代码项目中的 `freertos_demo.c`(或 `main.c`),找到核心演示逻辑
|
|
|
|
|
+2. 提取**完整的函数/代码块**作为示例(保留可独立运行理解的关键部分)
|
|
|
|
|
+3. 删除重复的模板代码(任务配置宏定义、`freertos_start` 等通用部分只写一次即可)
|
|
|
|
|
+4. 每段代码必须有**通俗解释**(用生活中的例子类比)
|
|
|
5. 复杂概念必须配**通俗类比**,确保小白能看懂
|
|
5. 复杂概念必须配**通俗类比**,确保小白能看懂
|
|
|
|
|
|
|
|
-示例(笔记中的代码段):
|
|
|
|
|
|
|
+示例(笔记中嵌入的格式):
|
|
|
```c
|
|
```c
|
|
|
// ========== 核心示例:发送消息 ==========
|
|
// ========== 核心示例:发送消息 ==========
|
|
|
// 保留了完整函数体,删除了任务创建等模板部分
|
|
// 保留了完整函数体,删除了任务创建等模板部分
|
|
@@ -399,13 +397,10 @@ flowchart TD
|
|
|
F --> G[撰写讲解正文<br/>代码 + 通俗解释]
|
|
F --> G[撰写讲解正文<br/>代码 + 通俗解释]
|
|
|
G --> H[API 视觉模型验证图片]
|
|
G --> H[API 视觉模型验证图片]
|
|
|
H --> I[精选+重命名图片到 assets/]
|
|
H --> I[精选+重命名图片到 assets/]
|
|
|
- I --> J[整体复制代码项目到 code/]
|
|
|
|
|
-
|
|
|
|
|
- J --> K[创建 raw/ 学习笔记]
|
|
|
|
|
-
|
|
|
|
|
- K --> L[从 raw 笔记提炼 wiki 知识页]
|
|
|
|
|
- L --> M[更新 wiki/index.md + log.md]
|
|
|
|
|
- M --> N[git commit<br/>ingest/raw/wiki]
|
|
|
|
|
|
|
+ I --> J[创建 raw/ 学习笔记<br/>代码核心示例嵌入正文]
|
|
|
|
|
+ J --> K[从 raw 笔记提炼 wiki 知识页]
|
|
|
|
|
+ K --> L[更新 wiki/index.md + log.md]
|
|
|
|
|
+ L --> M[git commit<br/>ingest/raw/wiki]
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
---
|
|
---
|