IDE的大多数兼容的C ++ Doxygen评论

时间:2012-01-23 19:54:42

标签: c++ cross-platform comments doxygen

我一直在研究一些与我合作的其他开发人员将使用的C ++代码。这里的很多开发人员都是基于MS的(他们使用Visual Studio作为他们的主要IDE)我们也有很多开发人员使用其他IDE以及不同的项目(比如Eclipse和Qt,甚至是使用XCode的一些C ++ Mac开发)。

我所拥有的代码是跨平台兼容的通用库函数,因此它将被不同平台/ IDE的不同开发人员使用。这让我想到了一个问题:是否有一个兼容的Doxygen评论'风格'可以被'理解'并与大多数流行的IDE(VS,Eclipse,Qt,Netbeans,XCode)的代码完成功能一起使用? 类似于VS的IntelliSence,当你使用你的范围结果时会弹出一个描述该项目的描述。

如果没有“兼容”的方式,是否有任何插件可以用于允许此功能的所有IDE,或者我是否必须自己编写?谷歌搜索引导我走向许多死胡同(可能是因为我可能没有将我的问题输入到正确的搜索术语中),编写我自己的插件是一种选择,尽管我更喜欢“兼容”风格或现有插件(如果可能的话)时间。

提前致谢!

编辑1:我应该提到我要求Doxygen风格评论,因为它是我们用来构建我们的一些文档的文档工具,因此我们制作的任何代码中的所有注释都必须是Doxygen风格(不知道为什么这个问题永远不会来到这里之前,哈哈)

1 个答案:

答案 0 :(得分:1)

所以我现在一直在努力解决这个问题。在过去,我使用了几个不同的软件套件进行开发,每个软件套件都有自己的怪癖,使用文档来驱动一些更奇特的功能。在使用C#(和Visual Studio 2010)开发项目之后,我逐渐意识到XML注释似乎对我来说是最好的。

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

但我与你原来的问题不同。当我第一次研究这个时,似乎Apple自己必须使用Doxygen,因为他们似乎使用了这个standard for highlighting code already。话虽如此,这里有一些其他资源可以在其他应用程序中获得相同的功能:

  • Atomineer Pro Documentation似乎是关于 Visual Studio 工作的工具,尽管我没有亲自使用它。使用起来似乎相对简单。
  • Eclox似乎是实际使用Doxygen的 Eclipse 的前端插件。但是从我记忆中你应该能够在C ++设置中调整IDE本身的语法高亮。
  • Doxymacs Emacs 中维护一个符号表,以获得一些快速搜索功能。
  • 似乎在 Vim 项目页面上有一个脚本可以为该编辑器处理这个,它被称为DoxygenToolkit

我绝对感受到你的痛苦。有一个温暖和令人讨厌的东西,让夜间crontab生成干净的文档标记,很容易搜索。我最近才开始寻找可用于实现这种跨平台的最佳机制。从我收集的内容来看,大多数开发环境都支持各种类型的扩展,并且由于Doxygen基本上是“黄金标准”,如果它不是开箱即用的话,通常会有这样或那样的方式来支持。“

如果您感兴趣Doxygen实际上支持开箱即用的C#XML注释,但遗憾的是我无法在Xcode中使用它,而且我不太熟悉AppleScript将它一起破解。但是,如果你这样做,请务必更新!