知识卡片
先记录想法再润色注释
写不出完善注释时,先记下当时的判断或疑虑,再重读并把情绪词、含糊指代和笼统评价换成明确的对象、限制与原因。用几轮小修改形成准确说明,比一直等待理想措辞更容易开始。尽早、持续记录可以避免临近结束才补一大批注释;草稿仍需澄清,不能把模糊原话当最终文档。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
几个简单的步骤: 1.不管你心里想什么,先把它写下来。 2.读一下这段注释,看看有没有什么地方可以改进。 3.不断改进。 当你经常写注释,你就会发现步骤1所产生的注释变得越来越好,最后可能不再需要做任何修改了。并且通过早写注释和常写注释,你可以避免在最后要写一大堆注释这
参考来源
- 位置:《编写可读代码的艺术》先写下想法,再改成准确注释(spine 2803;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2727.html`;来源键`s2803-ch05-009`)。
- 结论依据:正文与图103..131完整实读;示例的性能数字、参数及实现细节限定于原例,没有执行或推广为当前通用保证。
- 原始内容:几个简单的步骤: 1.不管你心里想什么,先把它写下来。 2.读一下这段注释,看看有没有什么地方可以改进。 3.不断改进。 当你经常写注释,你就会发现步骤1所产生的注释变得越来越好,最后可能不再需要做任何修改了。并且通过早写注释和常写注释,你可以避免在最后要写一大堆注释这