我正在创建一个使用面向对象编程的MATLAB软件包。我已经记录了我的课程根据教程从MathWorks网站。然而,这个文档标准只适用于doc和help命令,而不是当我使用publish时。例如,将其描述写在声明前的属性没有将其导出到HTML。文件开头没有属性或方法列表,因此用户可以快速跳过这些属性或方法。最后,文档必须直接从代码中的注释中读取,而不是被解析为HTML。
当我试图在类中添加一些HTML文档到publish中时,代码也会出现在doc和help上,这是一种不想要的行为。是否有一种方法可以创建类文档,以便将属性和方法发布到Web上?我曾经使用过文档生成器,如狮身人面像(Python)和氧气(许多语言),在这些生成器中,类、方法和属性的描述被解析为,这样就可以在读文档或GitHub页面这样的地方发布它们,所以我很想知道MATLAB是否有类似的东西。
发布于 2016-06-01 08:08:10
您可以尝试使用DO2的MTOC++,从而生成标准的produces文档。
我已经使用它为Matlab项目生成源代码文档,其中包含标准的Matlab函数、带有@ notation的旧类定义以及由classdef混合定义的类,并且经过一些裁剪之后才能工作。
这个稍微大一些的项目允许使用名为MatLab的doxygen过滤器为mtoc++文件和类(包括包)创建文档。此外,名为MatlabDocMaker的工具/类允许在MatLab中创建文档。对于Windows,Mac和Unix!
您也可以在Mathworks文件交换上找到它,也可以找到文档这里。
发布于 2016-06-01 12:44:15
为MATLAB函数/类提供HTML文档的一种广泛使用的方法是M2HTML项目。它将自动生成HTML文档,包括依赖关系图、源代码和语法突出显示。
https://stackoverflow.com/questions/37562403
复制相似问题