【发布时间】：2015-06-26 19:06:16
【问题描述】：
我在 MATLAB 中有一个 OO 项目，想自动生成一些文档。
经过一些研究，我发现了一个名为 mtoc++ 的便捷工具，它显然使用 Doxygen 生成文档（我没有经验）。
我唯一的问题是，为了使用该工具，我是否需要使用特定格式（语言？）在 MATLAB 中编写 cmets，以便 mtoc++/Doxygen 可以理解并记录我的 cmets？
如果是这样，那么这种格式/语言是什么，我在哪里可以找到它的描述？
【问题讨论】：
【发布时间】：2015-06-26 19:06:16
【问题描述】：
正确安装和配置mtoc++/Doxygen后，会自动创建文档。
如果您想为特定的自定义参数定义个性化的 cmets，您可以按照此页面上的说明进行操作：
http://www.ians.uni-stuttgart.de/MoRePaS/software/mtocpp/docs/tools.html
查看标题mtoc++ 过滤器的配置选项。
您需要做的是编辑 mtocpp.conf 文件，该文件位于 tools/config 文件夹中，您将使用的格式如下：
add(params) = <parameter1_name> => """Your parameter1 description text in triple quotes""";
一个例子是：
add(params) = myVariable => """This variable is defined by me""";
因此您可以为您的参数、字段、额外文档和全局设置定义个性化的 cmets。
我确信必须有其他解决方法来添加 cmets 和文档。
我希望这会有所帮助。编码愉快。
【讨论】：
-
您的回答让我怀疑我对该工具应该做什么的理解。我认为该工具会提取我在代码中编写的 cmets（用于类、方法、属性、事件）并将它们很好地组织在一个文档中，就像 Matlab 中的 doc 命令一样（但 doc 命令一次只为一个类创建文档，而不是为项目的所有类创建文档）。
-
是的，你是对的。这就是该工具要做的事情。您可以在 Matlab 源文件中添加 cmets，就像我们创建帮助文档一样，即在声明函数后，使用 % 在函数体之前添加该函数的描述。在这些 cmets 中，您可以使用 Doxygen 命令进一步格式化您的文档。所有 Doxygen 命令都以 @ 或 \ 开头。你可以在这里找到所有 Doxygen 命令的文档：stack.nl/~dimitri/doxygen/manual/commands.html
-
我还建议浏览示例文件，这些文件可以在 src/docs/+examples/ 文件夹中找到。