← 返回起始笔记位置

知识卡片

普通读书笔记卡 · 1793.j

注释保留未来理解所需信息

理解等级:中级

注释应帮助后来的人重新理解代码的目的与约束,而非把自增等语法再翻译一遍。假设维护者具备相近技术背景,把实现做了什么、为何这样安排的必要信息留下;否则一年后的自己也可能难以恢复设计思路。注释不是用数量替代可读代码。

可联系[[模块测试尽早暴露缺陷]]理解条件与边界。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      请在代码里留下些痕迹以帮助你自己找回记忆(文件和函数头)。总的说来,假设读者和你具有相同的心智和背景,只需写清楚这段代码做了什么,而不是如何做。

    参考来源

    - 位置:《嵌入式系统设计与实践》第1章《导论》(来源项目book-sources;extracted/嵌入式系统设计与实践/_epub-src/OEBPS/text00012.html;src-015)。 - 结论依据:原文对该机制、条件或案例的实质说明支撑本卡;保留本书历史实现范围及文中所列限制。 - 原始内容:请在代码里留下些痕迹以帮助你自己找回记忆(文件和函数头)。总的说来,假设读者和你具有相同的心智和背景,只需写清楚这段代码做了什么,而不是如何做。