知识卡片
缩写应能被新成员理解
缩写是否合适,取决于目标读者是否已有共同词汇。str、doc等常见约定可能直接可读,项目独有缩写则让新人甚至未来的作者重新查背景。用新成员能否理解来检查,而不是以自己已经熟悉为依据;领域确有通行缩写时也不必机械展开全部词。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
团队的新成员是否能理解这个名字的含义?如果能,那可能就没有问题。 例如,对程序员来讲,使用eval来代替evaluation,用doc来代替document,用str来代替string是相当普遍的。因此如果团队的新成员看到FormatStr()可能会理解它是什么意思,然
参考来源
- 位置:《编写可读代码的艺术》缩写能否被新成员理解(spine 2772;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2696.html`;来源键`s2772-ch02-013`)。
- 结论依据:本项正文及图11..52已完整读取;命名效果由具体案例说明,未执行或改写示例。
- 原始内容:团队的新成员是否能理解这个名字的含义?如果能,那可能就没有问题。 例如,对程序员来讲,使用eval来代替evaluation,用doc来代替document,用str来代替string是相当普遍的。因此如果团队的新成员看到FormatStr()可能会理解它是什么意思,然