已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。关闭6年前。Improvethisquestion我知道可以在评论中使用markdown，doxygen可以理解。但是我需要知道是否可以生成markdown格式的文档？我需要从C++文件生成这些文档。 最佳答案 我知道这个问题很老，但似乎有一个新工具可用:https://www.npmjs.com/package/doxygen2md
关闭。这个问题需要更多focused.它目前不接受答案。想要改进这个问题吗？更新问题，使其只关注一个问题editingthispost.关闭4年前。Improvethisquestion我喜欢用Doxygen创建C或PHP代码的文档。我有一个即将到来的Python项目，我想我记得Python没有/*..*/注释，并且还有自己的self文档工具，这似乎是Python的文档方式.由于我熟悉Doxygen，如何使用它来生成Python文档？有什么特别需要我注意的吗？ 最佳答案 doxypy输入过滤器允许您以标准Python文档字符串格式使
关闭。这个问题是opinion-based.它目前不接受答案。想改善这个问题吗？更新问题，以便可以通过editingthispost用事实和引文回答问题.3年前关闭。Improvethisquestion我们都有记录代码的好习惯，对吧？如今，代码内文档本身具有语法。它几乎就像一种编程语言。问题是:存在哪些(多少)文档语法规范？是否有标准的文档语法？谁来定义这个标准？是否有官方委员会或机构(例如定义C++标准的委员会或机构)？还是“doxygen”已成为事实上的标准？很难没有听说过doxygen。在我参与的每个开源软件项目中都会提到它。然而，查看doxygen官方网站，显然，doxyge
我在使用Doxygen识别命名空间和模块时遇到问题。我认为问题在于是否将\addtogroup放置在命名空间内或命名空间外。示例1，命名空间外:/*!*\addtogroupRecords*@{*///!GenericrecordinterfacesandimplementationsnamespaceRecords{//!DescribestherecordinterfaceclassInterface;}//EndnamespaceRecords/*!@}EndofDoxygenGroups*/示例2-在命名空间内//!Genericrecordinterfacesandimple
我正在使用EclipseCDT编写C++代码。在阅读了StackOverflow上关于是否将doxygen文档放在头文件或实现文件中的几个讨论后，似乎大多数开发人员都倾向于将doxygen注释放在头文件中(当然，这绝不是共识)。但是，如果我将doxygen注释放在我的头文件中，当我将鼠标指针悬停在注释方法/成员的实例上时，我无法让Eclipse显示这些注释。有没有办法让Eclipse在Eclipse的悬停提示中使用我的头文件中的Doxygen文档？我已在Preferences>C/C++>Editor中将“DocumentationtoolcommentsWorkspacedefaul
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题吗？更新问题，以便editingthispost提供事实和引用来回答它.关闭4年前。Improvethisquestion我有一个项目，我正在使用Doxygen为其生成文档。类的文档很好，但我也有一些用于创建对象等的非成员函数。我也希望将这些记录在案，但无论我尝试什么，Doxygen都不会生成文档我放在函数上方的评论。为什么Doxygen不会为全局命名空间中的函数生成文档，我需要做什么才能让它工作？ 最佳答案 作为类成员的实体只有在其类被记录时才会被记录。
已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。关闭4年前。Improvethisquestion我正在寻找用于doxygen代码文档的eclipse插件。我找到了eclox-plugIn(http://home.gna.org/eclox/)。我想知道，它如何自动生成一个“空”的doxygen注释，可以稍后填写，或者文档eclipse插件的更好选择是什么？例如对于一个函数:voidf(intp1,intp2,...)，它应该生成:/*!\brief.
我一直在寻找一些描述如何使用doxygen生成简单类图的Material，但找不到。有人可以帮忙吗？我需要从一组C++文件中创建如下所示的图表。如果有更好的工具可以更轻松地实现这一点，请告诉我。 最佳答案 嗯，这似乎是一个老问题，但是由于我最近几天一直在搞乱Doxygen配置，而我的脑海中仍然充满了当前的信息，让我们试一试-我觉得前面的答案差不多了:缺少的选项是在Doxyfile中添加COLLABORATION_GRAPH=YES。我假设你可以在doxywizardGUI的某个地方做同样的事情(我不使用doxywizard)。因此，
我一般是编程新手，所以我决定从用C++制作一个简单的vector类开始。不过，我想从一开始就养成良好的习惯，而不是以后尝试修改我的工作流程。我目前只有两个文件vector3.hpp和vector3.cpp。随着我对一切变得更加熟悉，这个项目将慢慢开始增长(使其更像是一个通用线性代数库)，所以我想采用“标准”项目布局，让以后的生活更轻松。所以环顾四周后，我发现了两种组织hpp和cpp文件的方法，第一种是:project└──src├──vector3.hpp└──vector3.cpp第二个是:project├──inc│└──project│└──vector3.hpp└──src└─
如果你有一个可能抛出异常的公共(public)函数，它使用其他(私有(private)或公共(public))辅助函数也可能抛出异常，我认为你应该记录公共(public)函数可以抛出哪些异常，这包括由辅助函数。类似这样的东西(使用Doxygen):/***@throwException...*@throwExceptionThrownByHelper...*@throwExceptionThrownByHelpersHelper...*/voidtheFunction(){helperWhichMayThrowException();}和helperWhichMayThrowExcep
