知识卡片

普通读书笔记卡 · 1915.b.10

接口说明应明确边界行为

理解等级:中级

接口中的日常名词可能有多种定义,应通过边界情况检查它是否足够精确。统计行数若实际只数换行字节,就应直接这样说明,让调用者知道无换行文本返回0、回车不会计入。说明要匹配真实行为,不能仅靠一个熟悉名称让调用者猜测。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      统计换行符(\n)的个数(这就是Unix命令wc的工作原理)。下面的注释对于这种实现方法更好一些: 这条注释并没有比第一个版本长很多,但包含更多信息。它告诉读者如果没有换行符,这个函数会返回0。它还告诉读者回车符(\r)会被忽略。

    参考来源

    - 位置:《编写可读代码的艺术》以边界情况澄清行为定义(spine 2808;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2732.html`;来源键`s2808-ch06-004`)。 - 结论依据:本项正文与图132..158完整实读;按图核对参数、边界与返回索引,不把教学片段当完整实现或已执行测试。 - 原始内容:统计换行符(\n)的个数(这就是Unix命令wc的工作原理)。下面的注释对于这种实现方法更好一些: 这条注释并没有比第一个版本长很多,但包含更多信息。它告诉读者如果没有换行符,这个函数会返回0。它还告诉读者回车符(\r)会被忽略。