知识卡片
注释应回答意外疑问
从不熟悉实现的读者视角,找出看似反常却有理由的代码,并用注释交代这个理由。这样的说明能防止后续维护者把有意设计误改为看似更直观的写法。要解释实际机制和意图,避免把有限情境的技巧写成普遍保证;例如交还容器缓冲区给分配器并不承诺操作系统立刻回收内存。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
为什么他不直接用data.clear()而是与一个空的向量交换?”实际上只有这样才能强制使向量真正地把内存归还给内存分配器。这不是一个众所周知的C++细节。起码要加上这样的注释:
参考来源
- 位置:《编写可读代码的艺术》回答读者看到异常写法时的疑问(spine 2799;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2723.html`;来源键`s2799-ch05-006`)。
- 结论依据:正文与图103..131完整实读;示例的性能数字、参数及实现细节限定于原例,没有执行或推广为当前通用保证。
- 原始内容:为什么他不直接用data.clear()而是与一个空的向量交换?”实际上只有这样才能强制使向量真正地把内存归还给内存分配器。这不是一个众所周知的C++细节。起码要加上这样的注释: