知识卡片
调用参数注释应放在值前
调用中若数字或布尔值难以辨认,可在值前用参数名和等号标注,例如/use_encryption=/false,并把单位写入timeout_ms一类名称。值后的说明容易让人弄不清false否定了什么。支持具名参数时可直接使用语言能力;注释只帮助阅读,不能防止参数顺序或名称失配。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
在值的前面加上/*name=*/尤其重要。把注释写在值的后面让人困惑: 在上面这些例子中,我们不清楚false的含义是“使用加密”还是“不使用加密”。 大多数函数不需要这样的注释,但这种方法可以方便(而且紧凑)地解释看上去难以理解的参数。
参考来源
- 位置:《编写可读代码的艺术》在调用处说明难辨认的参数(spine 2811;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2735.html`;来源键`s2811-ch06-006`)。
- 结论依据:本项正文与图132..158完整实读;按图核对参数、边界与返回索引,不把教学片段当完整实现或已执行测试。
- 原始内容:在值的前面加上/*name=*/尤其重要。把注释写在值的后面让人困惑: 在上面这些例子中,我们不清楚false的含义是“使用加密”还是“不使用加密”。 大多数函数不需要这样的注释,但这种方法可以方便(而且紧凑)地解释看上去难以理解的参数。