概述
开发者通常需要为其代码创建文档。编写说明和用户手册是日常活动, 且为与客户沟通的重要组成部分。此外, 随着时间的推移, 我们积累了很多不同的函数库和代码片段, 其中包括其他开发者编写的函数库和代码片段。结构良好的文档可以帮助您更轻松地了解这些素材。当开发代码时如果我们牢记需要编写手册, 这个任务不需要额外的时间。所需的注释和标签会在代码创建的同时加入。第一感觉, 这个任务可能看起来并非必要, 但如果这样做, 可在后来为开发者节省大量的时间和精力。
我们来从头到尾研究文档创建过程, 同时详细分析最重要的关键点。之前已经写过相关的 文章, 但其中描述的一些信息和方法没有更多的相关性。我们尝试进一步拓展这个话题。我们主要研究使用 Doxygen 软件和 Doxywizard.exe。
将 MQL 文件添加到 Doxygen
我们的目标是将位于一个或多个文件中的已编写代码根据现有标记来创建一个帮助/演示文档。作为结果, 我们将得到 chm 格式的文件。此外, 我们还将创建 html 文件, 它也可用于演示或参考目的。我们将使用 Doxygen 软件, 它很适合上述任务。
在 上面提及的文章 中描述了程序设置过程和结果文件的输出。但它是在很久以前发表的, 且那些曾描述过的指令如今已不能正常工作。如果我们遵循那些描述, 程序运行不会有警告和错误消息, 但却不会创建文件。
所以, 我们首先要做的事情就是更新程序配置描述。启动 doxywizard.exe 进行配置: 指定您的项目名称, 输入和输出文件夹, 并确认在 向导 选卡的 模式 部分
