用C或MATLAB编写的组织/显示算法的方法



关于如何显示代码正在做什么(C或MATLAB)有任何建议吗?想象一下,如果你的代码真的很长,而且你的程序中有很多函数,那么记录程序的最佳方式是什么?我知道Java ide有一种方法可以吸收注释,并将它们输出到显示所有函数及其输入和输出的文档中。我不认为C或MATLAB有这个特性。在这一点上,我认为注释是显示代码中发生的事情的唯一方法,但是如果读者必须在注释旁边查看原始代码,可能会感到困惑。第二种选择是在文本编辑器(如Microsoft Word)中编写算法。有这样做的行业标准吗?

谢谢!

Java使用的是JavaDoc。

对于C,您可以使用氧。

我也看到了这个,这表明你也可以使用matlab中的氧气!

文字编程之母是http://www-cs-faculty.stanford.edu/~uno/cweb.htmlcweb。父亲是高德纳。

最近版本的MATLAB实际上有一些非常类似的功能。如果你在面向对象的类中实现你的MATLAB代码,MATLAB会自动为你生成文档,只需输入doc myClassName -它真的非常类似于氧。如果您不使用面向对象的代码,您可以使用MATLAB发布从您的脚本和函数生成文档。

氧的C支持是相当不错的。它支持JavaDoc风格和Qt风格的标记注释,以及一些额外的特性。有关标记的示例,请参阅手册。我没有现成的输出示例,但是它是非常可定制的。

Octave项目实现了一种语言和环境,它实际上是Matlab的超集,使用texinfo来记录其功能。您可以在手册的文档提示部分中看到标记的示例。我建议滚动到页面底部查看完整的标记示例,而不是阅读前面的冗长解释。除了使用Octave中的帮助外,我几乎没有使用texinfo的经验,但我相信在线手册是从texinfo源生成的,因此它似乎足够强大。

最新更新