知识卡片
代码要分段落
把相关声明或连续处理步骤组织为段落,读者便能先看高层分组,再按需读细节。空行提供可见定位点和导航,必要时可加简短的段落意图说明。分组应对应实际职责或步骤,而不是随意每隔几行插空白;若局部层次本身不清,还需重新组织逻辑。
段落也可用于连续步骤:相关想法放一起,空白提供读到哪里的位置线索,并帮助在不同步骤间导航。段长随任务选择,不机械等分代码。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
- · 代码要分段落
- · 把函数组织成代码段落
- · 第4章小结
- · 用总结帮助读者进入低层步骤
原书出处 · 4 处
- · 查看原书依据
按逻辑把它们分成组,像以下这样: 这个版本容易理解多了。它还更易读,尽管代码行数更多了。原因是你可以快速地找出4个高层次段落,然后在需要时再阅读每个段落的具体内容。
- · 查看原书依据
可见的“脚印”,如果没有它,会很容易找不到你读到哪里了。 ·它便于段落之间的导航。 因为同样的原因,代码也应当分成“段落”。例如,没有人会喜欢读下面这样一大块代码: 可能看上去并不明显,但这个函数会经过数个不同的步骤。因此,把这些行代码分成段落会特别有用: 请注意,我们
- · 查看原书依据
用空行来把大块代码分成逻辑上的“段落”。
- · 查看原书依据
深入了解细节之前就能得到该函数的主旨。(如果这些大段很容易分开,你可以直接把它们写成函数。正如我们前面提到的,好代码比有好注释的差代码要强。) 注释应该说明“做什么”、“为什么”还是“怎么做”? 你可能听说过这样的建议:“注释应该说明‘为什么这样做’而非‘做什么’(或者
参考来源
- 位置:《编写可读代码的艺术》按逻辑分组声明(spine 2790;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2714.html`;来源键`s2790-ch04-002`)。
- 结论依据:本项正文及图77..102完整实读;按既有语义前提理解版式改进,不把外观或布局约定当正确性保证。
- 原始内容:按逻辑把它们分成组,像以下这样: 这个版本容易理解多了。它还更易读,尽管代码行数更多了。原因是你可以快速地找出4个高层次段落,然后在需要时再阅读每个段落的具体内容。
- 位置:《编写可读代码的艺术》把函数组织成代码段落(spine 2791;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2715.html`;来源键`s2791-ch04-002`)。
- 结论依据:本项正文及图77..102完整实读;按既有语义前提理解版式改进,不把外观或布局约定当正确性保证。
- 原始内容:可见的“脚印”,如果没有它,会很容易找不到你读到哪里了。 ·它便于段落之间的导航。 因为同样的原因,代码也应当分成“段落”。例如,没有人会喜欢读下面这样一大块代码: 可能看上去并不明显,但这个函数会经过数个不同的步骤。因此,把这些行代码分成段落会特别有用: 请注意,我们
- 位置:《编写可读代码的艺术》第4章小结(spine 2793;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2717.html`;来源键`s2793-ch04-002`)。
- 结论依据:本项正文及图77..102完整实读;按既有语义前提理解版式改进,不把外观或布局约定当正确性保证。
- 原始内容:用空行来把大块代码分成逻辑上的“段落”。
- 位置:《编写可读代码的艺术》用总结帮助读者进入低层步骤(spine 2802;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2726.html`;来源键`s2802-ch04-002`)。
- 结论依据:正文与图103..131完整实读;示例的性能数字、参数及实现细节限定于原例,没有执行或推广为当前通用保证。
- 原始内容:深入了解细节之前就能得到该函数的主旨。(如果这些大段很容易分开,你可以直接把它们写成函数。正如我们前面提到的,好代码比有好注释的差代码要强。) 注释应该说明“做什么”、“为什么”还是“怎么做”? 你可能听说过这样的建议:“注释应该说明‘为什么这样做’而非‘做什么’(或者