知识卡片

操作参考卡 · 5620.a.1.d.3.b

示例命名关联具体文档对象

理解等级:中级

Example对应包,ExampleF对应函数F,ExampleT对应类型T,ExampleT_M对应方法;可加以小写开头的下划线后缀区分同一对象的示例。命名让文档工具把可编译示例放到正确API附近,而不只是方便人搜索;示例的输出断言与这层文档关联各有作用。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • 程序测试和文档 · 查看原书依据

      ExampleT_M_basic。 我们为什么要在这里特别强调样本测试函数的命名呢?你会在5.2节中找到答案。 以上内容就是我们编写样本测试函数所需要的全部知识。

    参考来源

    - 位置:《Go并发编程实战》第05章《程序测试和文档》之《5.1 程序测试》(来源项目book-sources;源文件:extracted/Go并发编程实战/_epub-src/text/part0000_split_035.html) - 结论依据:原文围绕示例命名关联具体文档对象给出定义、实例或限制;卡片结合这些上下文解释条件,已知错误在正文就近校正。 - 原始内容:ExampleT_M_basic。 我们为什么要在这里特别强调样本测试函数的命名呢?你会在5.2节中找到答案。 以上内容就是我们编写样本测试函数所需要的全部知识。