最兼容的C++;IDE的Doxygen注释';s 我一直在研究一些C++代码,我将使用的其他开发人员使用这些代码。这里的许多开发人员都是基于MS的(他们使用VisualStudio作为他们的主要IDE),我们也有很多开发人员使用不同的IDE,也适用于不同的项目(比如伊柯丽斯和QT,甚至一些用XCODEL开发的C++ Mac)。p>

最兼容的C++;IDE的Doxygen注释';s 我一直在研究一些C++代码,我将使用的其他开发人员使用这些代码。这里的许多开发人员都是基于MS的(他们使用VisualStudio作为他们的主要IDE),我们也有很多开发人员使用不同的IDE,也适用于不同的项目(比如伊柯丽斯和QT,甚至一些用XCODEL开发的C++ Mac)。p>,c++,cross-platform,comments,doxygen,C++,Cross Platform,Comments,Doxygen,我的代码是跨平台兼容的通用库函数,因此它将被不同平台/IDE上的不同开发人员使用。这就引出了我的问题:是否有一种兼容的Doxygen注释“风格”,可以被最流行的IDE(VS、Eclipse、Qt、Netbeans、XCode)理解并与代码完成功能一起使用? 类似于VS的IntelliSence,当您使用范围结果时,会弹出该项的描述 如果没有一个“兼容”的方式,是否有任何插件可以用于所有IDE,以允许这种能力,或者我会写我自己的?谷歌搜索让我陷入了许多死胡同(可能是因为我可能没有将问题输入正确的搜

我的代码是跨平台兼容的通用库函数,因此它将被不同平台/IDE上的不同开发人员使用。这就引出了我的问题:是否有一种兼容的Doxygen注释“风格”,可以被最流行的IDE(VS、Eclipse、Qt、Netbeans、XCode)理解并与代码完成功能一起使用? 类似于VS的IntelliSence,当您使用范围结果时,会弹出该项的描述

如果没有一个“兼容”的方式,是否有任何插件可以用于所有IDE,以允许这种能力,或者我会写我自己的?谷歌搜索让我陷入了许多死胡同(可能是因为我可能没有将问题输入正确的搜索词),编写自己的插件是一种选择,尽管为了节省时间,我更喜欢“兼容”风格或现有插件

提前谢谢


编辑1:我应该提到,我要求使用Doxygen风格的注释,因为它是我们用来构建一些文档的文档工具,因此我们所做的任何代码中的所有注释都必须是Doxygen风格的(不确定为什么这个问题以前从未出现过,哈哈)

,所以我已经为这个问题挣扎了一段时间。在过去,我使用了几个不同的软件套件进行开发,在使用文档驱动一些更奇特的功能方面,每个套件都有自己的怪癖。在C#(和VisualStudio2010)中完成一个项目后,我逐渐意识到XML注释似乎对我来说最合适

我个人认为这是大多数IDE应用程序本身的一个失败,例如,Visual Studio似乎只支持C#应用程序的XML注释,以提供Intellisense等功能,以及不太花哨的语法突出显示。我发现在VisualStudio中可以“启用”此功能,但为什么我要为尚未启用的功能付费

但我偏离了你原来的问题。当我第一次对此进行研究时,苹果公司自己似乎也必须使用强氧剂,就像他们使用强氧剂一样。话虽如此,这里有一些其他资源可以在其他应用程序中获得相同的功能:

  • 似乎是VisualStudio的工作工具,尽管我个人没有使用过它。它似乎使用起来相对简单
  • 似乎是Eclipse的前端插件,实际上使用了Doxygen。但是从我记得的,你应该能够在语法设置中在C++设置中调整IDE本身。
  • 在Emacs内部维护一个符号表,以实现一些快速搜索功能
  • 在Vim项目页面上,似乎有一个脚本也为该编辑器处理这个问题,它被称为
我完全能感觉到你的痛苦。让每晚的crontab生成易于搜索的清晰文档化标记,这是一件温暖而温暖的事情。我只是最近才开始努力寻找实现跨平台的最佳机制。从我收集的资料来看,大多数开发环境都支持各种扩展,而且由于Doxygen基本上是“金标准”,因此,如果没有现成的支持,通常会有一种或另一种方式来支持


如果您感兴趣,Doxygen实际上支持开箱即用的C#XML注释,但不幸的是,我无法在Xcode中使用它,而且我对AppleScript还不够精通,无法将其组合起来。但无论如何,请更新,如果你这样做

如果您的IDE理解doxygen,那么它可能理解所有内容。另一方面,如果它不起作用,那么无论您使用什么语法,它都可能不起作用。您是否遇到过IDEX不支持y这样的特定问题?@pezcode:Doxygen有很多方法来注释代码,主要是为了允许不同的注释模式工作。C#标准样式被接受(在不同程度上),JavaDoc样式也被接受。@pezcode:不幸的是,正如Nicol所说,由于注释代码的方法很多,Doxygen支持其中的许多方法,所以这不是IDEX不支持y的问题,而是我的其他开发人员的语法糖的问题。像Nicol所说的,C语言风格是支持的,但是只有VisualStudio IDE以C项目作为主要项目运行,所以如果在C++中运行C++代码(XCODEL可能不理解如何解析C语言风格,因此不会显示它),那就不起作用了。(或更多)注释我的代码的方法,以便许多不同的IDE可以“解析”注释,或者如果我必须为我知道正在使用的IDE编写插件来支持Doxygen“风格”注释,Visual Studio只需在同一行上获取任何注释(
void foo(){//do stuff
将在intellisense工具提示中显示
do stuff
),或在行上显示不需要任何特殊的SyScript,它不记得这个在2008中工作过,但是它是2010和更新的,至少它似乎会提供更好的结果。不是C++。我所描述的C++工作,不需要任何特殊的形式,对于最后的回复很抱歉,但是最终我还是用JavaDoc风格。注释..主要是因为它在我维护的其他代码中使用得更多。我想等我有时间的时候,我会为流行的IDE开发一些插件,这些插件可能会更好地处理XML/Doxygen风格的注释。