308得票20回答
使用doxygen记录代码的最佳技巧是什么?

我的团队开始使用Doxygen文档记录我们的C代码,尤其关注我们的公共API头文件。 Doxygen具有很大的灵活性和不同的特殊命令,这很好,但是在没有试错的情况下,不清楚什么是好事情,什么是坏事情。您喜欢如何标记您的代码?您有哪些必须做和禁止做的事项?请提供您的顶级提示,每个答案一个,以便投...

196得票4回答
Xcode 5有哪些新的文档命令可用?

Xcode 5的一个新功能是使用特殊注释语法来记录您自己的代码。格式类似于doxygen,但只支持那些功能的子集。 支持哪些命令,哪些不支持? 它们的用法是否与doxygen有所不同?

145得票8回答
Markdown中如何在创建PDF时进行分页?

我正在使用Doxygen(1.8.6)创建Markdown文本文件的PDF。现在我想要在Markdown文件中的特定位置插入分页符,我使用了这个链接。 在给定的链接中,他们提到要使用“>”进行换行。但是他们没有提到分页符。是的,我也可以使用“>”进行分页,但我必须在Markdown文本文件中...

140得票6回答
如何使用Doxygen制作介绍页面

我使用Doxygen为我的SDK制作了文档,其中包含文件列表、命名空间、类、类型等——所有我在代码中放置的Doxygen注释。现在我想写一些关于SDK的概括信息(介绍性内容),这与任何代码元素都没有直接关系。我想将此介绍放置在文档起始页面上。我该如何做?

139得票4回答
C++项目组织(使用gtest、cmake和doxygen)

我对编程一般都是新手,所以我决定从制作一个简单的C++向量类开始。然而,我想从一开始就养成良好的习惯,而不是试图在以后修改我的工作流程。 目前我只有两个文件vector3.hpp和vector3.cpp。随着我对所有东西的熟悉度越来越高,这个项目将会逐渐扩大(使它更像一个通用的线性代数库),所...

128得票6回答
如何使用Doxygen从C++源代码创建UML类图

我一直在寻找一些材料,描述如何使用doxygen生成简单的类图,但没有找到。有人可以帮忙吗? 我需要从一组C++文件创建如下所示的图表。 如果有更好的工具可以更轻松地实现此目的,请告诉我。

119得票8回答
内部库的Doxygen注释块应该放在哪里 - 在H文件还是CPP文件中?

常识告诉我们,Doxygen注释块必须放置在头文件中,其中包含类、结构体、枚举、函数声明等。我同意这是一个适用于将库分发为仅包含头文件和目标代码库的有力论据。 但是……当我开发一种公司内部(或自己的副业项目)完整源代码将被使用的库时,我考虑采用完全相反的方法。我的建议是在实现文件(HPP、I...

104得票5回答
如何使用Doxygen记录Python代码

我喜欢使用Doxygen来创建C或PHP代码的文档。我即将开始一个Python项目,并且我记得Python没有/* .. */ 注释,而且它有自己的自我文档功能,这似乎是用Python记录文档的方式。 鉴于我熟悉Doxygen,我如何使用它来生成我的Python文档?我需要特别注意什么吗?

91得票1回答
如何在同一个软件包中使用roxygen2和doxygen?

我有一个使用了 roxygen2 的 R 包。其中包含一些在 /src 中的 C 代码,并且我刚刚开始使用 Doxygen。是否有任何方法可以将这两种文档结合起来或将编译与 roxygen2 集成?关于放置 C 代码文档的位置,有没有什么“最佳实践”? 通过谷歌搜索 roxygen2 和 do...

83得票3回答
在Doxygen中引用参数的正确方法是什么?

我有一个函数的以下Doxygen文档:/** @brief Does interesting things @param[in] pfirst The first parameter: a barrel full of monkeys @pre "pfirst" mu...