用于程序程序的 Doxygen
我有一些大型的、大部分是程序性的代码,需要详细记录。这通常涉及重复使用必须按特定顺序执行的多个函数。
Doxygen 是一个很棒的产品,但它似乎非常面向记录 OOP 代码。有人对如何以自然的方式使用 doxygen 来记录程序工作有任何建议吗?
I have some large, mostly procedural codes that need to be well documented. This generally involves repeated use of a number of functions that must be executed in a certain order.
Doxygen is a great product, but it seems very oriented towards documenting OOP codes. Does anyone have any tips on how to use doxygen in a natural way to document procedural work?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
doxygen 的工作方式本质上没有什么面向对象编程的地方。它能够提取有关 OO 代码的更多信息,因为它包含更多信息(例如,继承图)。
我们将 doxygen 用于纯 C 代码,它的工作原理也一样,只是减去了与 C++ 相比纯 C 不提供的信息。只需使用 doxygen 的分组(@addtogroup 等)功能来组织生成的文档就可以了。
There's nothing inherently OOP about the way doxygen works. It's just able to extract more information about OO code because it has more information in it (e.g., inheritance graphs).
We use doxygen for plain C code and it works just as well, minus the information that plain C doesn't provide when compared to C++. Just use doxygen's grouping (@addtogroup et al) features to organize the generated documentation and you're good to do.