Questions tagged «doxygen»

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使它成为Stack Overflow 的主题。 2年前关闭。 改善这个问题 一个Xcode中5的新功能是一种特殊的注释语法来记录自己的代码的能力。格式类似于doxygen，但似乎仅支持这些功能的子集。 支持哪些命令，不支持哪些命令？ 它们的用法是否与doxygen不同？

186 objective-c  documentation  comments  doxygen  xcode5 

我是编程的新手，所以我决定从用C ++创建一个简单的矢量类开始。但是，我想从一开始就养成良好的习惯，而不是稍后再尝试修改我的工作流程。 我目前只有两个文件vector3.hpp和vector3.cpp。随着我对一切的熟悉，这个项目将开始慢慢发展（使它更多地成为通用的线性代数库），因此我想采用“标准”项目布局，以使以后的生活更轻松。因此，环顾四周后，我发现了两种组织hpp和cpp文件的方法，第一种是： project └── src ├── vector3.hpp └── vector3.cpp 第二个是： project ├── inc │ └── project │ └── vector3.hpp └── src └── vector3.cpp 您会推荐哪个？为什么？ 其次，我想使用Google C ++测试框架对我的代码进行单元测试，因为它似乎很容易使用。您是否建议将此与我的代码捆绑在一起，例如在inc/gtest或contrib/gtest文件夹中？如果捆绑在一起，您是否建议使用fuse_gtest_files.py脚本来减少数量或文件数量，或者保持原样？如果不捆绑在一起，该依赖性如何处理？ 在编写测试时，通常如何组织这些测试？我当时想为每个类创建一个cpp文件（test_vector3.cpp例如），但是全部编译成一个二进制文件，以便它们可以轻松地一起运行？ 由于gtest库通常是使用cmake和make构建的，所以我认为对我的项目也这样构建有意义吗？如果我决定使用以下项目布局： ├── CMakeLists.txt ├── contrib │ └── gtest │ ├── gtest-all.cc │ └── gtest.h ├── docs │ └── Doxyfile ├── inc …

123 c++  cmake  doxygen  googletest 

我使用Doxygen为我的SDK制作了文档。它包含文件，名称空间，类，类型等的列表-我在代码中作为Doxygen注释放置的所有内容。现在，我想写一些关于SDK的常规信息（介绍的种类），它与任何代码元素都不直接相关。我想将此介绍放在文档起始页上。我怎样才能做到这一点？

102 doxygen 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 常识告诉我们，Doxygen注释块必须放在类，结构，枚举，函数，声明所在的头文件中。我同意这是一个合理的论据，对于没有源的库（仅包含目标代码的标头和库）来说，这是合理的。 但是...在开发公司内部（或作为我自己的副项目）库时，我一直在想完全相反的方法，该库将与其完整的源代码一起使用。我建议将大注释块放在实现文件（HPP，INL，CPP等）中，以免使标头中声明的类和函数的界面混乱。 优点： 头文件中的混乱程度较小，只能添加功能分类。 例如，使用Intellisense时预览的注释块不会冲突-这是我在.H文件中具有函数的注释块并在同一.H文件中具有内联定义时观察到的缺陷。但包含在.INL文件中。 缺点： （显而易见的一个）注释块不在声明所在的头文件中。 那么，您如何看待并可能提出建议？

97 documentation  comments  doxygen 

已关闭。这个问题需要更加集中。它当前不接受答案。 想改善这个问题吗？更新问题，使其仅通过编辑此帖子来关注一个问题。 2年前关闭。 改善这个问题 我喜欢Doxygen创建C或PHP代码的文档。我有一个即将到来的Python项目，我想我还记得Python没有/* .. */评论，也有自己的自我文档编制功能，这似乎是Python的记录方式。 既然我熟悉Doxygen，如何使用它来生成我的Python文档？有什么特别需要我注意的吗？

94 python  documentation  doxygen  docstring  python-sphinx 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 我有一个R使用的软件包roxygen2。它在中有一些C代码/src，而我刚开始使用Doxygen。有什么方法可以合并文档或将编译器与roxygen2集成在一起？在哪里放置C代码文档有“最佳实践” 吗？ 对roxygen2和doxygen进行谷歌搜索主要导致roxygen与doxygen结果相似。我发现了一些带有Doxyfiles的软件包，但是没有一致的组织。例如，lme4已inst/doc/Doxyfile输出到源目录doxygen外部的文件夹lme4。Matrix的根目录中也有一个Doxyfile（但在以前的版本中是inst。该文档也被导出到package目录之外。 是否有任何理由不将C文档包含在软件包中，或者尽管Doxygen广泛使用，为什么Doxygen在R软件包中却很少使用C？ 更新：请参阅相关的roxygen2功能请求

91 c  r  documentation  doxygen  roxygen2 

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

90 c++  uml  doxygen  graphviz  class-diagram 

我正在使用doxygen（1.8.6）创建markdown文本文件的pdf。现在，我想在markdown文件的特定阶段获取分页符，我使用了此链接。 他们在给定的链接中提到使用'>'作为换行符。但是他们没有提到分页符。是的，我也可以使用'>'来进行分页符，但是我必须在markdown文本文件上写入此符号5次或更多次，这会使markdown文件看起来很奇怪。还有其他方法可以在markdown文件中获得分页符吗？

84 markdown  doxygen 

我需要为我的工作场所实施一个文档生成解决方案，并将其范围缩小到标题中提到的三个。通过对这些解决方案进行形式化比较的方式，我已经能够找到很少的信息，并且我希望那些具有上述一种或多种经验的人能够参与其中： 这是我从最初的通行证中学到的东西： HeaderDoc优点：与Apple的现有文档一致，与制作Apple文档集兼容 。HeaderDoc缺点：难以修改行为，项目未积极开展工作，许多人已经放弃了它（这意味着必须存在某些缺陷，尽管我无法对其进行量化） ）。 Doxygen优点：具有广泛使用基础，非常可定制的大多数输出​​类型（如乳胶等）的主动支持社区b / c Doxygen缺点：需要努力使其外观与Apple Docs一致，与Apple docsets的兼容性并不是那么简单 AppleDoc优点：外观与Apple现有文档一致，与制作Apple文档集兼容， AppleDoc缺点：积极开发typedef，枚举和函数文档的问题 这听起来准确吗？我们所需的解决方案将具有： 与Apple Objective-C类参考一致的外观 单击选项的功能可以从Xcode中提取文档参考，然后链接到文档（就像Apple的类一样） 智能处理类别，扩展名等（甚至包括苹果类的自定义类别） 能够创建我们自己的参考页（例如此页：正在加载...，其中可以包含图像，并且可以与生成的类引用进行无缝链接，例如Apple的UIViewController类引用如何链接到链接的页面。 易于运行的命令行命令，可以集成到构建脚本中 优雅地处理非常大的代码库 根据以上所有信息，上述任何解决方案是否明显优于其他解决方案？任何建议或补充信息将不胜感激。

74 doxygen  documentation-generation  headerdoc  appledoc