极客学院团队出品 · 更新于 2018-11-28 11:00:43

10 必备文档

本节内容描述了一些系统级文档,它们对于设计并维护 Erlang 编写的系统来说都是很关键的。

10.1 模块描述

One chapter per module. Contains description of each module, and all exported functions as follows:

每个函数都有的描述,其中包含了每个模块以及所有的导出函数的描述信息,如下所示:

  • 函数参数的含义和数据结构。
  • 返回值的含义和数据结构。
  • 函数的功能。
  • 有关失败以及可能由于显式调用 exit/1 所产生的退出信号的可能原因。

文档格式的定义稍后详述。

10.2 消息描述

除了定义在模块中的消息之外,所有的进程间消息的格式。

文档格式的定义稍后详述。

10.3 进程

有关系统中所有注册服务器以及它们的接口和用途的描述。

动态进程及其接口的描述。

文档格式的定义稍后详述。

10.4 错误消息

有关错误消息的描述。

文档格式的定义稍后详述。

上一篇: 最常见的错误