知识卡片

普通读书笔记卡 · 1915.b.1.a

注释应明确指代对象

理解等级:中级

注释里的它、这个或it若可能指向多个对象,应改成明确名词,或重组句子使指代唯一。读者不应为了理解说明而重新分析实现。例如缓存插入前检查大小,要明确检查的是待插入数据还是缓存自身,二者对应不同限制。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      可能指数据也可能是指缓存。可能在读完剩下的代码后你会找到答案。但如果你必须这么做,又要注释干什么呢? 最安全的方式是,如果在有可能会造成困惑的地方把“填写”代词。在前一个例子中,假设"it"是指"data",那么: 这是最简单的改进方法。你也可以重新组织这个句子来让"i

    参考来源

    - 位置:《编写可读代码的艺术》明确指代对象(spine 2806;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2730.html`;来源键`s2806-ch06-003`)。 - 结论依据:本项正文与图132..158完整实读;按图核对参数、边界与返回索引,不把教学片段当完整实现或已执行测试。 - 原始内容:可能指数据也可能是指缓存。可能在读完剩下的代码后你会找到答案。但如果你必须这么做,又要注释干什么呢? 最安全的方式是,如果在有可能会造成困惑的地方把“填写”代词。在前一个例子中,假设"it"是指"data",那么: 这是最简单的改进方法。你也可以重新组织这个句子来让"i