如何为 Ejabberd 自定义模块生成文档？

Question

我已经创建了一些自定义模块我需要为我的所有自定义模块创建文档有什么帮助吗？

Answer 1

您可以使用 edoc - http://erlang.org/doc/apps/edoc/chapter.html。例如： test_edoc.erl

-module(test_edoc).

-export([run/1]).

%% -------------------------------------------------------------------
%% @doc
%% Some description
%% @end
%% -------------------------------------------------------------------
-spec run(N :: integer()) -> Result :: integer() | error.

run(N) when is_integer(N) -> N + 1;
run(_) -> error.

然后在 Erlang 中 shell:

1> edoc:files(["test_edoc.erl"], [{dir, doc}]).
ok

然后在你运行 edoc:files/2的当前文件夹中应该生成doc文件夹，所以，转到doc文件夹并在浏览器中打开test_edoc.html