Question

我在MATLAB中有一个OO项目，并希望自动生成一些文档。

经过一些研究后，我找到了一个名为mtoc ++的方便工具，它显然使用Doxygen生成一个文档（我没有经验）。

我唯一的问题是，为了使用我需要使用特定格式（语言？）在MATLAB中编写注释的工具，以便mtoc ++ / Doxygen可以理解并记录我的注释？

如果是这样，那么这种格式/语言是什么以及我可以在哪里找到它的描述？

Answer 1

正确安装和配置mtoc ++ / Doxygen后，文档会自动创建。

如果要为特定自定义参数定义个性化评论，可以按照此页面上的说明进行操作：

查看标题 mtoc ++过滤器的配置选项。

您需要做的是编辑位于 tools / config 文件夹中的 mtocpp.conf 文件，您将使用的格式为：< / p>

add(params) = <parameter1_name> => """Your parameter1 description text in triple quotes""";

一个例子是：

add(params) = myVariable => """This variable is defined by me""";

因此，您可以为参数，字段，额外文档和全局设置定义个性化注释。

我确信必须有其他解决方法来添加注释和文档。

我希望这会有所帮助。快乐的编码。