我正在开发一个大型C++程序,现在我决定用Doxygen来记录它。有大量的类、方法、函数、宏等等。因此,我正在寻找能够扫描我的源代码树并在每个“可记录项目”顶部插入Doxygen注释block的软件,以便我稍后对其进行编辑并添加方法描述等详细信息。是否存在这样的软件?我在GNU/Linux下使用Code::BlocksIDE,所以不需要VisualStudio插件。 最佳答案 我在这里很困惑。自动生成评论的目的是什么?评论旨在带来额外的值(value):/***\brief:findsthepersonbasedonitsname*
我正在尝试使用DOxygen为相当大的代码库生成文档。我使用Doxywizard获得了适用于Windows的Doxygen1.8.10。我安装了Graphviz2.38我能够使用专家选项卡中的递归选项毫无问题地生成文本类层次结构。我在向导中选择了“使用GraphViz包中的点工具”选项。我还在点的“专家”选项卡中检查了“HAVE_DOT”和“CLASS_DIAGRAMS”选项。当我生成文档并单击ShowHTMLOutput时,我在GraphicalClassHierarchy下看不到任何内容。我仍然可以在文本类层次结构中看到所有类及其依赖项。在MozillaFirefox中,Graph
引用这个解决方案:CustomtagswithDoxygen如果我使用XML(c#)样式进行记录,这似乎不起作用。我试图添加一个“更改”标签:ALIASES="change=\xrefitemchange\"Change\"\"Changes\""但是,当我在文档中使用它时:BojanHrnkas,14.08.2012:Optimizedperformance.HTML输出如下所示:BojanHrnkas,14.08.2012:Optimizedperformance.有没有办法实现xml标签的别名? 最佳答案 实现此目的的一种方法
我最近从Doxygen1.8.4和GraphViz2.36升级到Doxygen1.8.7和GraphViz2.38,我在生成图形时没有问题,现在无法获取图形。在构建过程中,我遇到了大量的错误error:Problemsrunningdot:exitcode=-1,command='dot'arguements="myfile.dot"-Tpng-O"myfile.png"我已经降级到GraphViz2.36,问题消失了。注意-我尝试在DOT_PATH为空并将GraphViz添加到路径的情况下运行2.36,但这也不起作用。目前唯一可行的解决方案是定义了DOT_PATH的2.36。能否
我正在使用doxygen并具有以下代码:def__init__(self):''''''ifnot'_ready'indir(self)ornotself._ready:self._stream=sys.stderr##!出于某种原因,doxygen告诉我self._stream(Member_stream)没有记录。我可以用评论记录它吗,就像doxygendocu在Puttingdocumentationaftermembers中描述的那样如果是这样,正确的方法是什么?**编辑:**这似乎与我没有换行有关,例如这里:classescapeMode(object):'''Enumtor
有人知道一个python模块来解析doxygen风格的C++注释字符串吗?我的意思是像这样的字符串(简单示例):/***Aconstructor.*Amoreelaboratedescriptionoftheconstructor.*@paramparam1test1*@paramparam2test2*/我想提取简要说明、详细说明、参数、返回值等。我目前正在使用字符串方法和正则表达式执行此操作,但我的解决方案不是很可靠。或者有人可以推荐一个我可以快速设置的易于使用的python解析器库吗?提前致谢 最佳答案 您可以使用Simple
http://www.doxygen.nl/manual/docblocks.html中的“Python中的特殊文档block”给出了doxygen在Python中的使用示例。在doxygen生成的相应HTML文档中(网络中的示例输出),如果单击包名称,则会显示与该包相关的所有描述、类和函数。如果我从doxygen文档中获取相同的示例脚本,使用“doxygen-gconfig”创建配置文件并使用“doxygenconfig”生成html,那么输出是不同的。如果我单击包名称,则只会显示包说明,而不显示类和函数。为了在包文档中包含类和函数,我需要在配置文件或某些xml方案中更改什么。编辑1
有人可以帮我弄清楚如何正确地注释python代码以便被doxygen解析吗?它以某种方式忽略了标签。输出(HTML)显示标签:@briefCreatesanewHelloobject.ThisHelloObjectisbeeingusedto...@paramnameThenameoftheuser.我试过的两种变体都不起作用:classHello:"""@briefshortdescription...longerdescription"""def__init__(self,name):"""@briefCreatesanewHelloobject.ThisHelloObjectis
我最近在我的一个项目中使用Doxygen。我遇到了一个问题,它不会为C#静态类生成正确的文档。我必须启用某些选项吗?相关类的完整源代码是here.并且列出了命名空间的doxygen文件here.另外,我的Doxyfile是here.它是使用几乎默认设置从doxywizard生成的。如您所见,已生成该类的简短描述,但该类没有自己的页面来查看(记录的)静态方法和成员。此外,该类未列在类索引中,或实际上在其他任何地方。有什么问题? 最佳答案 自从我创建doxygen配置以来已经有一段时间了,但是尝试将EXTRACT_STATIC的值更改为
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我们目前正在使用DoxyGen来记录用C/C++、PHP和Java编写的代码。要拥有一致的环境,最好也将它用于C#文档。但是我们想知道:您是否看到使用DoxyGen以外的东西生成的文档布局或结构有什么优势?我们正在为具有C#和.NET平台经验的外部开发人员生成文档。也许他们习惯了某种文档格式?DoxyGen与VisualStudio的集成程度如何?有什么东西可以从IDE内部一键生成文档吗?