文章 "MQL5 代码自动生成文档"

新文章 MQL5 代码自动生成文档已发布:

大多数 Java 代码编写者熟悉可通过 JavaDocs 创建的自动生成文档。其思路是以一种半结构化的方式向代码添加注释,然后可以将这些注释提取到易于导航的帮助文件。C++ 世界也有若干文档自动生成器,其中微软的 SandCastle 和 Doxygen 是两款领先产品。本文说明使用 Doxygen,从 MQL5 代码的结构化注释创建 HTML 帮助文件。试验非常成功,我认为 Doxygen 从 MQL5 代码生成的帮助文档会增加很多价值。

作者:Paul

做得好!虽然它只适用于销售 MQL5 库 :(

好文章!

我可以在 MQL4 中使用它吗?毕竟它很像 C 语言,而 doxygen 也应该支持 C 语言。
gordon   :
我可以在 MQL4 中使用它吗?毕竟它很像 C 语言,而 doxygen 也应该支持 C 语言。

是的,可以,Gordon。 在第二个向导模式屏幕上有一个选项,可以 "优化 C 或 PHP 输出"。 显然,所有 MQL4 函数都是全局的,因此没有 MQL5 类分组的优势。

我在下面附上了使用 C 选项时LibOrderReliable 的一些输出截图。 LibOrderReliable 是对 MQL4 交易函数的一个非常完善的文档包装,使其更加安全可靠。 为了让文档出现在 Doxygen 输出中,代码内注释需要进行类似于我对 MQL5 代码所做的调整。

保罗

http://p aulsfxrandomwalk.blogspot.com/

哦,我明白你说的类的意思了。所以,也许真的不值得在 MQL4 中使用它。

感谢您的文章!这正是我需要的。也许还有 msdn 风格的生成器?

为包含俄语注释的程序创建文档 时,必须指定正确的编码。

否则,您可能会得到俄语注释,而不是正方形注释:

在 Doxygen 的项目选项(Expert->Project)中,DOXYFILE_ENCODING 选项默认设置为 UTF-8、

因此在准备文档时,最好创建一个单独的文件夹,将文件以 UTF-8 编码保存:

结果是

另一个重要选项OUTPUT_LANGUAGE(输出 语言),使用指定语言(俄语)可以创建俄语菜单和说明:

文档可以让您更轻松地研究程序的结构和属性,因此请尽量将文档附在源代码之后。

Автоматическое создание документации к программам на MQL5
Автоматическое создание документации к программам на MQL5
  • 2009.11.23
  • Paul
  • www.mql5.com
Большинство Java программистов знакомы с автоматическим созданием документации, которая может быть создана при помощи программы JavaDocs. В мире C++ также есть несколько автоматических генераторов документации, одними из лидеров являются программы Microsoft's SandCastle и Doxygen. В статье описано, как можно использовать программу Doxygen для создания структурированных файлов справки HTML для программ, написанных на MQL5. Результаты данной работы убедили меня использовать Doxygen (или похожие программы) в будущем для создания документации к любому моему коду на MQL5, это значительно облегчает его понимание и использование.
Automated-Trading писал(а) # :

因此,在准备文件时,最好创建一个单独的文件夹,将文件以 UTF-8 编码保存:

在 "输入 "选项卡上将 INPUT_ENCODING 设置为 windows-1251 会更方便。编码方面没有问题
GarF1eld писал(а) # :
在输入选项卡上将 INPUT_ENCODING 设置为 windows-1251 会更方便。编码方面没有问题

这当然更简单。

但由于某些原因,doxygen(我的版本是 1.6.2)会在所有文件中插入

<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>。

虽然在设置中

即文件采用了所需的编码,如果在所有 html 文件中替换为

<meta http-equiv="Content-Type" content="text/xhtml;charset=windows1251"/>

但问题是如何打败它,让它自己做到这一点。
老实说,我并没有注意到,因为我对 UTF-8 很满意,而且当我遇到 crocoblasts 问题时,我只是更改了 INPUT_ENCODING。
12
要添加评论,请登录注册