本周文件交换精选

我们最好的用户提交

记录你的依赖

发布的客人选择器，

64次(最近30天 喜欢| 4评论

格雷格本周的选择是使用Doxygen与MATLAB通过法布里斯．

曾经想要一个MATLAB类的类依赖关系图和文档。如何利用Doxygen记录你的开发项目?

Fabrice提供了一个简单的接口来实现这一点。有趣的是，这个条目实际上并不包含MATLAB代码!

内容

优雅的关系

你想知道MATLAB类是如何相关的吗?

inherit_graph_0

上面的图片显示了我正在处理的一个项目的类层次结构的子集，我能够使用Fabrice的工具生成它。

图表在方框中描述了每个类。箭头指向继承每个类的父类。

依赖路径的终端是MATLAB中的一个内置类，在本例中是“handle”。

文档呢?

如果您在MATLAB Code中使用注释来记录函数和类，那么您需要应用Fabrice的额外约定“%>”而不仅仅是“%”来确定哪些注释会被Doxygen解析。

此外，Doxygen约定是函数的文档默认出现在函数之前，这在MATLAB中的约定是它出现在函数之后。为了确保您的文档在Doxygen中可用并使用MATLAB DOC函数，那么您可能需要考虑在MATLAB函数或类参数定义后的第一个注释中使用“<”标志。

我确实对Fabrice条目中的Perl脚本进行了快速修改，以自动化该过程，以便将“%>”替换为“///<”，并假定MATLAB文档总是出现在函数或参数定义之后。

使用MATLAB已经可以获得文档

已经有一个文档机制可用的MATLAB已经。以及这种能力显示自定义文档作为MATLAB文档系统的一部分。

您可以在MATLAB代码中使用注释来生成文档，而不需要做任何额外的工作。然而，它在开发依赖关系图方面并没有提供太多内容。

这应该在MATLAB或Simulink中实现吗?金宝app

  • 您是否使用Doxygen来记录您的软件开发项目?
  • 这个功能应该内置到MATLAB或Simulink中吗?金宝app
  • 生成的C或hdl代码呢?
  • 在MATLAB中使用Doxygen的方法不同吗?

让我们知道在这里．




MATLAB®8.6发布

|
类别:
选择
  • 打印
  • 发送电子邮件

另请参阅

评论

要留下评论，请点击在这里登录到您的MathWorks帐户或创建一个新帐户。