erlang edoc 使用教程

edoc使用文档  org文档

生成的默认方法为

application(Application::atom()) -> ok

Equivalent to application(Application, []).

application(Application::atom(), Options::proplist()) -> ok

application(Application::atom(), Dir::filename(), Options::proplist()) -> ok

假如你的工程目录是按照otp标准建立的，直接运行 eodc:application(your_project_name)

如果运行 application/1 出错有两种可能

1：工程中写的注释不符合edoc规范

       edoc 规范 链接 edoc规范

       比较需要注意的有

       (1)函数名必须与 @doc 后面的函数名一致

       (2)函数的参数以及返回类型必须是以下类型中的一种                             

    any()
    arity()
    atom()
    binary()
    bitstring()
    bool()