Doxygen不会显示任何特殊注释

Question

我决定记录我项目的代码。我在网上找到了这个工具 Doxygen 并下载了它。

但是当我尝试实际创建HTML文件时，它只显示项目内容，而不是函数上方的任何特殊注释。

我尝试了所有类型的评论 - /*! ... */，/** ... */，///，//!

它只在.h文件中显示函数的名称及其定义，如下所示：

我该如何解决这个问题？如何启用Doxygen以显示特殊注释？

Answer 1

Doxygen本身是一种非常有效的工具，但您必须学习如何使用它。关键是配置文件。命令：

doxygen -g

将为您生成当前文件夹中的默认值。然后，您需要通过名为doxywizard的GUI程序直接使用任何文本编辑器对其进行编辑。默认选项值通常是一个好的开始，但也许你换了东西？

这种评论方式应该有效：

/// define foo
#define foo 42

/// a truely efficient function
void foobar();

struct A {
    int b; ///< this is something
};

Answer 2

如果我理解正确，你只是在代码注释中使用这些特殊标记以通常的方式放置在函数内部？检查您的前端是否未使用

  

<强> HIDE_IN_BODY_DOCS

     

如果HIDE_IN_BODY_DOCS标记设置为YES，则doxygen将隐藏在函数体内找到的任何文档块。如果设置为NO，这些块将附加到函数的详细文档块中。

     

默认值为：NO。

您可能还想启用

  

<强> EXTRACT_ALL

     

如果EXTRACT_ALL标记设置为YES，doxygen将假定文档中的所有实体都已记录，即使没有可用的文档。除非EXTRACT_PRIVATE个EXTRACT_STATIC标记设置为YES，否则将隐藏私有类成员和静态文件成员。

     

请注意

     

这也将禁用有关WARNINGS设置为YES时通常会生成的未记录成员的警告。

     

默认值为：NO。

我没有专门测试函数体中的注释是否计为“文档可用”，但如果您没有doxygen格式的参数文档，我肯定会打开EXTRACT_ALL。< / p>