Question

假设我有一个头文件，其中包含一些函数和多个源文件，这些文件实现了头提供的功能。我想使用Doxygen记录函数，但只记录有关所有实现的一般注释，而不是特定于实现。

仅查看标题注释的最佳方法是什么？我无法将配置设置为忽略所有源文件，因为项目中的某些其他源文件根本没有标题。

例如：

api.h

/**
*  @details
*   This is general comment for header
*
*********************************************************************/

implemenation1.c

/**
*  @details
*   This is implementation specific comment for file 1
*
*********************************************************************/
int foo(int a, int b)
{
  ...
}

implemenation2.c

/**
*  @details
*   This is implementation specific comment for file 2
*
*********************************************************************/
int foo(int a, int b)
{
  ...
}

我只想看到关于Doxygen的评论：

This is general comment for header

提前致谢！

Answer 1

到目前为止，我发现的最佳解决方案是：

<强> api.h

/**
*  @details
*   This is general comment for header
*
*********************************************************************/

<强> implemenation1.c

/**
*  @details
*   This is implementation specific comment for file 1
*
*  @cond
*********************************************************************/

int foo(int a, int b)
{
  ...
}

/** @endcond */

<强> implemenation2.c

/**
*  @details
*   This is implementation specific comment for file 2
*
*  @cond
*********************************************************************/

int foo(int a, int b)
{
  ...
}

/** @endcond */

Doxygen：记录具有多个实现的单个API

1 个答案: