Documentation 程序程序用强氧剂

我有一些大型的，主要是程序性的代码，需要很好的文档化。这通常涉及重复使用一些必须按特定顺序执行的函数

---

Doxygen是一个很棒的产品，但它似乎非常倾向于记录OOP代码。有人知道如何以自然的方式使用doxygen来记录程序性工作吗？

doxygen的工作方式并没有本质上的OOP。它只是能够提取更多关于OO代码的信息，因为其中包含更多信息（例如，继承图）

---

我们使用了DoXEGEN用于C代码，它也可以工作，减去与C++相比，普通C不提供的信息。只需使用doxygen的分组（@addtogroup et al）功能来组织生成的文档，就可以了。

那么枚举类型的事情呢，不仅仅是记录单个函数或对它们进行分组，而是以某种顺序实际显示它们？例如，程序的主要迭代部分必须按特定顺序调用20-40个函数。我希望能够在一个大型例程中的每个函数调用上方粘贴某种注释块，描述正在执行的操作，并将大型例程的输出设置为某种有序列表。如果有一组函数需要按特定顺序调用，然后，您应该在这些函数API中记录它们——可能将它们分组在一个组中，并让组描述说明它们应该如何一起使用。但是你不会在呼叫网站上记录这一事实。谢谢，我今天会尝试一下，看看效果如何。我更喜欢在调用站点记录这些内容，因为这是一个CUDA程序，使用额外的网格/线程/内存参数调用内核的方式会改变内核本身的行为。i、 例如，调用站点上存在的信息/参数在函数本身中不可见。如果这些函数必须按特定顺序执行，请编写一个包装器。