10 必備文檔

本節(jié)內(nèi)容描述了一些系統(tǒng)級文檔，它們對于設(shè)計并維護 Erlang 編寫的系統(tǒng)來說都是很關(guān)鍵的。

10.1 模塊描述

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

每個函數(shù)都有的描述，其中包含了每個模塊以及所有的導(dǎo)出函數(shù)的描述信息，如下所示：

• 函數(shù)參數(shù)的含義和數(shù)據(jù)結(jié)構(gòu)。
• 返回值的含義和數(shù)據(jù)結(jié)構(gòu)。
• 函數(shù)的功能。
• 有關(guān)失敗以及可能由于顯式調(diào)用 exit/1 所產(chǎn)生的退出信號的可能原因。

文檔格式的定義稍后詳述。

10.2 消息描述

除了定義在模塊中的消息之外，所有的進程間消息的格式。

文檔格式的定義稍后詳述。

10.3 進程

有關(guān)系統(tǒng)中所有注冊服務(wù)器以及它們的接口和用途的描述。

動態(tài)進程及其接口的描述。

文檔格式的定義稍后詳述。

10.4 錯誤消息

有關(guān)錯誤消息的描述。

文檔格式的定義稍后詳述。