问题标签 [doxygen]

我正在编写一个 C++ 静态库，并且我一直在对实现文件中的 doxygen 注释进行评论。我从来没有真正关心过文档，但我现在正在做一些需要为用户做好记录的东西，而且我正在尝试用更好的软件工程来取代我以前只想编码而不是文档的坏习惯实践。

无论如何，前几天我意识到我需要几种不同类型的文档，一种用于库用户（doxygen 手册），然后为我自己或未来的维护者提供更多处理实现细节的评论。

我的解决方案之一是将文件、类和方法的 doxygen 注释放在实现文件的底部。在那里它们会不碍事，我可以在方法定义中/周围包含普通注释以使程序员受益。我知道这需要更多的工作，但这似乎是我实现两种不同类型的评论/文档的最佳方式。您是否同意或有任何可能有用的解决方案/原则。我环顾了该站点，但实际上找不到任何处理此问题的线程。

另外，我真的不想在界面文件中乱扔注释，因为我觉得让界面自己说话会更好。如果用户需要更深入地了解库界面，我宁愿将手册作为用户可以查看的地方。我在正确的轨道上吗？

非常感谢任何想法或评论。

编辑：感谢大家的评论。我从听到他们的声音中学到了很多。我想我对如何将我的用户手册与对维护者有用的代码注释分开有了更好的理解。我喜欢@jalf 关于拥有“散文”风格手册的想法，该手册有助于解释如何使用该库。我真的认为这比参考手册要好。话虽这么说……我也觉得参考手册可能真的派上用场了。我想我会将他的建议与其他人的想法结合起来，并尝试创建一个混合体。（链接到参考手册的散文手册（使用 doxygen 标记，如 page、section、subsection）。）我喜欢@jalf 的另一个建议代码的想法是没有完整的手动交错插入其中。我可以通过将我所有的 doxygen 注释放在实现文件的底部来避免这种情况。这样可以使标头干净，实现干净，以放置对维护实现的人有用的注释。我们将看看这在现实中是否可行。这些只是我对到目前为止所学到的东西的想法。我不肯定我的方法会奏效，甚至是实用的。只有时间证明一切。

如何让 eclox 在 Eclipse 3.5 中工作？

我正在使用 Ubuntu 9.04。我从 ubuntu 存储库（版本 1.5.8）安装了 Doxygen。然后我通过更新站点在eclipse上安装了eclox。

尽管如此，我在任何菜单中都没有任何选项来启动它。

此外，eclox 网站似乎没有任何“入门”指南。

请帮忙。

在 PHP 项目中，即使在主应用程序使用前端控制器逻辑时，也可能存在许多独立脚本、ajax 片段等。

是否有一种标准化的方式——PHPDoc 或其他方式——在脚本的第一个注释块中定义脚本将接受/需要的 GET 和/或 POST 参数以及它们的类型？

我通常通过添加@params 来帮助自己，就好像文件是一个函数一样，并@return解释了脚本的作用和返回，但也许有一种我不知道的更专业的方法。

关于 doxygen 的乳胶输出，我有 2 个问题：如何组织相关页面（由 \page 创建的页面）？（它们似乎是根据页面标题组织的）如何指定要使用的乳胶样式表？（我在 Doxyfile 中一无所获）

我想摆脱班级成员的段落编号。

谢谢

我正在从事一个 C 项目，该项目已经看到了许多不同的作者和许多不同的文档样式。

我是doxygen和其他文档生成工具的忠实粉丝，我想迁移这个项目以使用这些系统之一。

是否有人知道可以扫描源代码注释以查找“描述”、“作者”、“文件名”等关键字和其他类型的上下文以智能地将注释转换为标准格式的工具？如果不是，我想我可以编写一个疯狂的脚本，或者手动转换。

谢谢

我已经设置了SOURCE_BROWSER = NO，VERBATIM_HEADERS = YES因为我希望客户能够看到头文件。但是，我只想让他们看到某些标题。最好的方法是如何做到这一点。

提前感谢您的帮助！

编辑：这似乎可行，但我会对任何其他更好的方式感兴趣。

有人知道可以从未记录的 xsl 文件中提取代码结构的工具吗？

我知道有 XSLTdoc，它可以从 xsl 文件中提取文档元素来构建 html 参考页面。但是对于未记录的 xsl 文件，XSLTdoc 的输出是相当无用的。

即使没有记录代码，Doxygen 也能够产生有价值的输出。是否存在可用于 xsl 的类似工具？

到目前为止我发现的最好的是depgraph，这个小样式表为包含和导入生成依赖关系图。

我正在寻找的是用于 xsl 模板的调用图生成器。

有什么方法可以更改评论块中的版本吗？

例如

我知道如何通过预处理来做到这一点，我想知道是否还有其他方法？

在相关的说明中，你们如何处理更改文档、应用程序等中的版本号，而不需要到处更改不同的版本号？现在我VER在所有人都可以访问的命名空间中有一个类似的变量（基本上是全局的，没有命名空间污染）。

我在使用 Doxygen 识别名称空间和模块时遇到问题。我相信问题围绕着是将 放在\addtogroup命名空间内还是命名空间外。

示例 1，在命名空间之外：

示例 2 - 在命名空间内

我希望namespace Records出现在 Doxygen命名空间选项卡下，并间接出现在模块选项卡下。单击Namespaces页面中的项目应生成一个包含Records::Interface. 单击“模块”选项卡中的项目也应生成一个包含Records::Interface.

在我的 Doxygen 文档中，我在模块中的命名空间选项卡中缺少项目，反之亦然，这是由于这种困境导致我的不一致。

那么哪个是正确的方法，示例 1 或示例 2？{Doxygen 手册对此主题并不清楚。}
Doxygen：\addtogroup
Doxygen：记录命名空间

有没有人尝试在 Lazy C++ 源文件中嵌入 Doxygen 注释？任何问题？生成头文件/源文件后，Doxygen 注释去哪里了？