Erlang eDoc：功能文档注释don'；输出中没有显示

我正在努力向Erlang最佳实践学习；刚刚将eDoc集成到我的工作流程中

这对我很有用：

%%% --------------------------------------------------------------------
%%% @author Lloyd R. Prentice
%%% @copyright 2011 Lloyd R. Prentice
%%% @doc Yada yada
%%%      ...
%%% @end
%%% --------------------------------------------------------------------

正如我所期望的，所有的东西都出现在文档中

但这并不是：

%% Return a list of reserved item types
item_types() ->
        ....

我希望在eDoc输出中看到函数和文档注释的列表。但是，没有演出

我浏览了eDoc文档，在网上查找示例和教程，但我看不出我做错了什么

有人能帮忙吗

非常感谢,

LRP来自：

除了前导“%”字符和空格外，标记必须是注释行的第一项

---

这可能是原因吗？

如果您正确调用了edoc，根据您的示例，我希望看到模块的大纲以及函数名，但不是每个函数的文档

在每个导出函数的正上方，您需要添加一个

@spec

标记和/或一个

-spec

标记以及一个

@doc

标记。你可以看到这些解释和解释。如果您有（或正在瞄准）最新版本的erlang（>14B02？），edoc将读取

-spec

信息，否则您需要使用

@spec

例如：

%% @spec item_types() -> list()
%% @doc Return a list of reserved item types.
item_types() ->

或

---

注意

在

-spec

末尾的

首先，只有导出的函数显示在生成的文档中（除非您将选项“private”传递给EDoc，告诉它也显示所有未导出的函数）。因此，如果您没有这样的声明：

  -export([item_types/0]).

在您的模块中，将不显示该功能

其次，必须以@doc开始函数声明上方的注释，如中所示：

  %% @doc Return a list of reserved item types
  item_types() ->

---

没有@-标记的注释只是注释，EDoc会忽略它。

不需要额外的空格/行。您只需使用顶部的工具栏将部分文本标记为“代码”。这将以预格式化的形式输出节。为你修好了。

  %% @doc Return a list of reserved item types
  item_types() ->