【问题标题】:What should be put in a "module" or "group" in Doxygen?在 Doxygen 的“模块”或“组”中应该放什么?
【发布时间】:2014-01-29 14:06:46
【问题描述】:

这类似于this question,但更具体一点。放在组或模块中的预期元素是什么?如果我将整个文件包括 @file 构造,该文件仍列在全局文件部分。如果我不这样做,它会更有意义,但仍然没有概要,描述模块的详细文本也不见了。即使有详细文本,它也不在顶部,也很难找到。对它的引用不会转到详细信息部分,而是转到模块。我开始相信它一定是为了其他目的。我的问题是目的是什么?打算将哪些东西放入一个组中?

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    Doxygen Groups 经常被忽视的价值在于,它们使您能够将逻辑上相关但在代码中分开的东西汇集在一起​​(在您的文档中)。

    假设您有两个模块/类/任何东西。一种是Bowl,一种是Fruit。每个都是一个单独的代码 Module 并且应该保持这样,并且在 doxygen 输出中是这样描述的。

    但是,您希望为用户提供一些有关如何制作水果碗的指导。

    通过在 Bowl 和 Fruit 的相关代码部分中使用 ingroup Fruitbowls,生成的文档会自动描述您对 Fruit、Bowls、 Fruitbowls 的需求,而无需额外的文本(除了\defgroup fruitbowls 允许您在某个地方介绍水果和碗类中水果碗的组装,等等)。

    本质上,组是一种将共享逻辑用途的代码段而不是代码结构(即模块)聚集在一起的方式。

    【讨论】:

    • 你错过了我的问题的要点。 “通过在代码的相关部分中使用 ingroup Fruitbowls”——相关部分是什么?它是“文件”还是只是特定的结构或只是功能或全部三个? @sections 效果不佳。其他人都有问题。
    • @section 命令用于组织纯文本 - 它与代码无关。 “相关部分”是指您选择的任何内容都与(在我的示例中)Fruitbowls 相关,用@ingroup @{@} 包围它。是否围绕特定结构、方法或整个文件完全由您选择。
    • 使用组的一种更简单的方法(如果您不希望这种矩阵优势)是简单地用相同的组名包装多个相关文件的内容。与 OO 语言相比,这可能与 C 更相关。
    • 你仍然完全错过了这个问题。
    • 还不错;我认为你仍然完全错过了团体的意义。我试图回答“打算将哪些东西放入一个组中?”。如果这不是问题,我建议你改写它。
    猜你喜欢
    • 2012-11-12
    • 2019-08-11
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2022-11-27
    • 1970-01-01
    • 2011-02-02
    • 1970-01-01
    相关资源
    最近更新 更多