命令'rebar doc‘不一致

Question

首先，“钢筋医生”有时起作用，有时不起作用。这很奇怪。我使用的钢筋版本是2.5.1

我的文件夹结构是：

1. Header_Directory 1.1应用程序 1.1.1 sub_dir_1 1.1.2 sub_dir_2 /包括 1.1.3 sub_dir_3 1.2 deps 1.3告解 rebar.config

sub_dir_3中的模块还使用sub_dir_3_2/ include文件夹中的一些包含文件。

当我使用命令rebar文档时，我得到的错误是： .sub_dir_3/src/my_log_worker.erl，在模块标题:第9行:文件未找到: some.hrl edoc:跳过源文件'sub_dir_3/src/my_log_worker.erl'：{'EXIT'，src}。edoc: doclet 'edoc_doclet'：{'EXIT'，error}中的错误。错误:在处理/home/learn/头目录/app/sub_dir_3：{'EXIT'，error}时，doc失败

我做“钢筋清除”，然后“钢筋编译”在“钢筋文档”之前。

而且，当我在错误的shell中这样做时，我会得到错误。

文件(“some_log_worker.erl”，[])。 edoc:读取文件‘Somelogworker.erl’时出错。 **异常退出：{error，enoent} 在edoc函数中:read_source/2 (edoc.erl，第664行)在调用从edoc_ function :edoc_extract.erl/3 (edoc_extract.erl，第52行) 从edoc呼叫:read/2 (edoc.erl，第537行) 从edoc调用:file/2 (edoc.erl，第116行)

有什么方法可以将我的hrl文件包含在rebar.config或edoc选项中吗？

我有“{edoc_opts，{ i，”app/sub_3/包含“}”。在rebar.config，仍然没有帮助。

Answer 1

看起来您没有遵循rebar/OTP约定：

OTP公约 Rebar期望项目遵循OTP设计原则文档中描述的OTP约定:应用程序 应用程序应由以下一组目录组成： src ebin priv包括 并有一个应用程序资源文件: ebin/example_project.app或src/examyproject.app.src。在后一种情况下，在编译阶段，从src/样例_project.app.src文件自动生成ebin/example_project.app文件。

钢筋和OTP运输机

我建议你搬到那个文件组织中去，从像钢筋这样的标准工具中获益会简单得多。

Answer 2

是的，遵守检察官办公室的原则始终符合最佳利益。然而，它适用于我的应用程序结构。

唯一的问题是erlang模块中的@headerfile注释。不知何故，我不知道如何正确使用@headerfile注释。

谢谢你的帮助。:)