文章 "基于 MQL5 源代码创建文档"

 

新文章 基于 MQL5 源代码创建文档已发布:

本文研究从所需的标签标记开始自动为 MQL5 代码创建文档。它还提供了如何使用、如何正确配置 Doxygen 软件, 以及如何以不同格式接收结果 (包括 html, HtmlHelp 和 PDF) 的说明。

含有示例的文件名称在此处设置。在第二行中, 您可以列出示例中要说明的函数或类。但这还不够: 我们还不知道文件所在的位置。含有示例的文件路径应在 Doxygen 中明确指定。我们应该指定文件的路径及其名称的范式。参见下图:

作者:Andrei Novichkov

 

我有一个问题,不完全是关于这篇文章的,而是关于 Doxygen 的。我知道你使用的是 1.8.13 版,但我也直接通过命令行使用。出于某些原因,在我得到的 html 帮助中,所有的 "目录参考 "直通页面都不显示它们所包含的子文件夹。我的意思是,例如,有这样一个文件夹结构:MQL4,包含通常的子文件夹 "包含 "和 "脚本"。如果点击文档菜单中的文件列表项,就会看到一个包含文件夹和文件的正常树形结构。例如,如果点击 Include 文件夹,就会看到包含所有文件的 "include 目录参考 "页面。但是,如果我点击更高层次的 MQL4,就会看到 "MQL4 目录参考 "页面,它有一个副标题 "目录",但下面既没有 "包含",也没有 "脚本"。其他文档,包括您的文档,都没有这个问题。问题出在哪里?

我已经尝试过用不同的方法在配置中填写 INPUT,我认为这是第一个配置错误的候选项,我更改了 RECURSIVE - 但没有任何帮助 - 除了这个恼人的细微差别外,文档总是以一切正常的方式创建。

 
Stanislav Korotky:

我试过用不同的方法在配置中填入 INPUT,我认为这是配置不正确的第一个候选项,于是更改了 RECURSIVE - 但都无济于事 - 除了这个恼人的细微差别外,创建的文件总是一切正常。

采用了你的配置。它能为我的源文件生成帮助,而不会出现上述问题。现在我必须在这里和那里比较十几个选项;-/

 
Stanislav Korotky:

我采用了你的配置。它为我的数据源生成了帮助,没有出现所述问题。现在我必须在这里和那里比较十几个选项 ;-/

为了以防万一,我把结果写了下来--也许对某人有用。结果发现 EXTRACT_ALL 对其有影响。如果选择 "否",则不显示文件夹;如果选择 "是",则显示文件夹。我认为这是生成器的一个错误。

 

下午好。

我可能来不及回复了 )))))))。我记得在 Doxygen GUI 中有一个选项可以勾选 "包括子目录"。我不太记得它在哪里了,但还是有可能找到的。