blocks|key|4984896|text|Java使用的是JavaDoc。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|4984897|对于C语言，你可以使用Doxygen。|4984898|我还看到了this，它建议你也可以在matlab中使用Doxygen！|4984899|entityMap|0|LINK|mutability|MUTABLE|url|http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html|1|http://www.doxygen.nl/|2|http://www.mathworks.com/matlabcentral/fileexchange/25925-using-doxygen-with-matlab^0|8|7|0|0|B|7|1|0|5|4|2|0^^$0|@$1|2|3|4|5|6|7|T|8|@]|9|@$A|U|B|V|1|W]]|C|$]]|$1|D|3|E|5|6|7|X|8|@]|9|@$A|Y|B|Z|1|10]]|C|$]]|$1|F|3|G|5|6|7|11|8|@]|9|@$A|12|B|13|1|14]]|C|$]]|$1|H|3|-4|5|6|7|15|8|@]|9|@]|C|$]]]|I|$J|$5|K|L|M|C|$N|O]]|P|$5|K|L|M|C|$N|Q]]|R|$5|K|L|M|C|$N|S]]]]

What Java uses is <a href="http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html" rel="nofollow noreferrer">JavaDoc</a>.

For C, you can use <a href="http://www.doxygen.nl/" rel="nofollow noreferrer">Doxygen</a>.

I also saw <a href="http://www.mathworks.com/matlabcentral/fileexchange/25925-using-doxygen-with-matlab" rel="nofollow noreferrer">this</a> which suggests you can use Doxygen with matlab too!

blocks|key|3371129|text|所有识字编程之母是http://www-cs-faculty.stanford.edu/~uno/cweb.html+cweb。孩子的父亲是Knuth。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|3371130|entityMap|0|LINK|mutability|MUTABLE|url|http://www-cs-faculty.stanford.edu/~uno/cweb.html^0|9|1D|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

The mother of all literate programming is <a href="http://www-cs-faculty.stanford.edu/~uno/cweb.html" rel="nofollow">http://www-cs-faculty.stanford.edu/~uno/cweb.html</a>
cweb. The father is Knuth.

blocks|key|914837|text|最近的MATLAB版本确实有一些与此非常相似的功能。如果您在面向对象的类中实现MATLAB代码，MATLAB将只需输入doc+myClassName即可为您auto-generate+documentation+-它真的非常类似于Doxygen。如果您没有使用面向对象的代码，您可以使用MATLAB+publishing从您的脚本和函数生成文档。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|914838|entityMap|0|LINK|mutability|MUTABLE|url|http://www.mathworks.com/help/techdoc/matlab_prog/brubzjb-1.html#brubz7_-1|1|http://www.mathworks.com/help/techdoc/matlab_env/f6-22451.html^0|1N|F|26|R|0|46|A|1|0^^$0|@$1|2|3|4|5|6|7|P|8|@$9|Q|A|R|B|C]]|D|@$9|S|A|T|1|U]|$9|V|A|W|1|X]]|E|$]]|$1|F|3|-4|5|6|7|Y|8|@]|D|@]|E|$]]]|G|$H|$5|I|J|K|E|$L|M]]|N|$5|I|J|K|E|$L|O]]]]

Recent versions of MATLAB actually do have some features very similar to this. If you implement your MATLAB code in object-oriented classes, MATLAB will <a href="http://www.mathworks.com/help/techdoc/matlab_prog/brubzjb-1.html#brubz7_-1" rel="nofollow">auto-generate documentation</a> for you by just typing <code>doc myClassName</code> - it's really quite similar to Doxygen. If you're not using object-oriented code, you can use MATLAB <a href="http://www.mathworks.com/help/techdoc/matlab_env/f6-22451.html" rel="nofollow">publishing</a> to generate a document from your scripts and functions.

blocks|key|917588|text|Doxygen的C语言支持非常好。它支持JavaDoc样式和Qt样式的标记注释，以及一些附加功能。有关标记外观的示例，请参阅the+manual。我手头还没有输出的示例，但它非常可定制。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|917589|Octave项目使用texinfo来记录其功能，该项目实现的语言和环境实际上是Matlab的超集。您可以在手册的Documentation+Tips部分中看到该标记的示例。我建议滚动到页面底部来查看完整的标记示例，而不是阅读前面冗长的解释。除了在Octave中使用帮助之外，我几乎没有使用texinfo的经验，但我相信在线手册是从texinfo资源中生成的，所以它似乎足够强大。|917590|entityMap|0|LINK|mutability|MUTABLE|url|http://www.doxygen.nl/|1|http://www.doxygen.nl/manual/docblocks.html|2|http://www.gnu.org/software/octave/|3|http://www.gnu.org/software/texinfo/|4|http://www.gnu.org/software/octave/doc/interpreter/Documentation-Tips.html#Documentation-Tips^0|0|7|0|1Q|A|1|0|0|6|2|A|7|3|1K|I|4|0^^$0|@$1|2|3|4|5|6|7|V|8|@]|9|@$A|W|B|X|1|Y]|$A|Z|B|10|1|11]]|C|$]]|$1|D|3|E|5|6|7|12|8|@]|9|@$A|13|B|14|1|15]|$A|16|B|17|1|18]|$A|19|B|1A|1|1B]]|C|$]]|$1|F|3|-4|5|6|7|1C|8|@]|9|@]|C|$]]]|G|$H|$5|I|J|K|C|$L|M]]|N|$5|I|J|K|C|$L|O]]|P|$5|I|J|K|C|$L|Q]]|R|$5|I|J|K|C|$L|S]]|T|$5|I|J|K|C|$L|U]]]]

<a href="http://www.doxygen.nl/" rel="nofollow noreferrer">Doxygen</a>'s C support is quite good. It supports JavaDoc style and Qt style markup comments, as well as some additional features. See <a href="http://www.doxygen.nl/manual/docblocks.html" rel="nofollow noreferrer">the manual</a> for examples of what the markup looks like. I don't have an example of the output ready to hand, but it's quite customizable.

The <a href="http://www.gnu.org/software/octave/" rel="nofollow noreferrer">Octave</a> project, which implements a language and environment that's effectively a superset Matlab's, uses <a href="http://www.gnu.org/software/texinfo/" rel="nofollow noreferrer">texinfo</a> to document its functions. You can see an example of the markup in the <a href="http://www.gnu.org/software/octave/doc/interpreter/Documentation-Tips.html#Documentation-Tips" rel="nofollow noreferrer">Documentation Tips</a> section of the manual. I recommend scrolling to the bottom of the page to view a complete markup example rather than reading the lengthy explanation that precedes it. I have little experience with texinfo beyond using help from within Octave, but I believe the online manual was generated from texinfo sources, so it seems sufficiently capable.

Is there any recommendations for how to show what your code is doing (C or MATLAB)? Imagine if your code is really long and you have a lot of functions in your program, what is the best way to document the program? I know Java IDEs have a way to ingest comments and spit them back out into a document that shows all the functions, and their inputs and outputs. I don't think C or MATLAB has this feature. At this point, I am thinking comments are the only way to show what is going on in the code, but it may confuse the reader if they have to look through the raw code along side the comments. The second option would be to write out the algorithm in a text editor such as Microsoft Word. Is there an industry standard for doing this?

Thanks!

Methods for organizing/showing algorithm that is coded in C or MATLAB

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

对于如何显示代码正在做什么(C或MATLAB)，有什么建议吗？想象一下，如果你的代码真的很长，并且你的程序中有很多函数，那么记录程序的最好方法是什么？我知道Java IDE有一种方法来接收注释，并将它们输出到一个文档中，该文档显示了所有函数及其输入和输出。我不认为C或MATLAB有这个特性。在这一点上，我认为注释是显示代码中发生的事情的唯一方法，但如果读者必须在查看注释的同时查看原始代码，那么注释

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

回答 4

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

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

回答 4

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

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