docs(algo): sample_ring_window 注释收敛,长推导移到设计说明

- 设计说明第 5 节已详述「为什么需要 / 设计思想 / start 推导」,函数内不再复述:
  环内布局示意、两条坑的逐句论证、取值范围推导全部删去,改为一句结论 + 指针
  (docs/算法/采集与算法层设计说明.md §5 与 §5.3)。
- 留在代码里的都是「就地可判」的落地要点:通道号为何先转 unsigned、
  n 的两条拒收理由、-2 与 -1 的语义区分、先加 DEPTH 的同余理由、逐点取模。
- .h 的指针从 .c 改指设计说明,避免同一事实两处详述。
- 净减 81 行;去注释后代码 token 与 HEAD 逐字相同;@build 0 错 0 警。
This commit is contained in:
2026-10-29 17:19:42 +08:00
parent c377fc8c15
commit 929cacbd72
2 changed files with 16 additions and 81 deletions
+2 -2
View File
@@ -60,8 +60,8 @@ int sample_ring_push_frame(const float *values, uint8_t n);
* 限定条件:无
* 函数说明:out[n-1] 为最新一点。相量层以本函数取"以当前时刻为终止的一周波"。
* ⚠ 仅 adcTask 上下文调用(写者与读者同任务串行,本层不加锁);
* 环内布局、窗首下标推导与"先加 DEPTH 再减 n"的理由见
* `App/algo/sample_ring.c` 同名函数的注释。
* 为什么需要这一层、环内布局与窗首下标的推导 →
* `docs/算法/采集与算法层设计说明.md` §5。
*/
int sample_ring_window(adc_semantic_t ch, uint8_t n, float *out);