记录你的依赖关系
格雷格他本周的选择是在MATLAB中使用Doxygen通过法布里斯.
曾经想要一个类依赖关系图和MATLAB类的文档。杠杆呢Doxygen记录您的开发项目?
Fabrice提供了一个简单的接口来实现这一点。有趣的是,这个条目实际上并不包含MATLAB代码!
内容
优雅的关系
你想知道MATLAB类是如何相关的吗?
上面的图像显示了我一直在做的一个项目的类层次结构的子集,它是我使用Fabrice的工具生成的。
该图在一个方框中描述了每个类。箭头指向继承每个类的父类。
依赖路径的终点是MATLAB中的内置类,在本例中为“handle”。
文档呢?
如果您在MATLAB代码中使用注释来记录函数和类,那么您需要应用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吗?
让我们知道在这里.
- カテゴリ:
- 选择
コメント
コメントを残すには,ここをクリックしてMathWorksアカウントにサインインするか新しいMathWorksアカウントを作成します。