1

什么是条件化文本（不是代码）的最佳方法。我希望对 3 个级别的文档进行条件化并标记为： 开发人员- 这将是我根本不希望 doxygen 输出的文档。比如给开发者的注释。 内部– 仅对文档的内部版本可见的信息。 NDA - 客户信息以及未标记为开发人员或内部的任何信息；内部文档的一个子集，例如会过滤掉内部网站。

4

1 回答 1

0

有许多 doxygen 命令和配置选项可以帮助您实现这一目标。这些包括\internal和\endinternal。来自 doxygen 手册：

\internal此命令启动仅供内部使用的文档片段。

您可以INTERNAL_DOCS在配置文件中使用来显示 ( YES) 或隐藏 ( NO) 内部文档。

要解决您想要的三个版本的文档：

  • 开发人员：使用标准 C/C++ 注释，/* ... */. 这些不会被 doxygen 触及。

  • Internal：对于仅供内部使用的文档，使用 doxygen 注释， ，并使用and命令/** ... */包装文档的这些部分。在内部分发文档时，将配置文件选项设置为构建文档时。\internal\endinternalINTERNAL_DOCSYES

  • NDA：对于客户可见的文档，只需在构建文档时使用 doxygen 注释并在配置文件中设置/** ... */配置选项。INTERNAL_DOCSNO

于 2012-09-06T16:54:39.560 回答