IDE的大多數兼容的C ++ Doxygen評論

Question

我一直在研究一些與我合作的其他開發人員將使用的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風格（不知道為什么這個問題之前從未出現過哈哈，哈哈）

Answer 1

所以我現在一直在努力解決這個問題。 在過去，我使用了幾個不同的軟件套件進行開發，每個軟件套件都有自己的怪癖，使用文檔來驅動一些更奇特的功能。 在C＃（和Visual Studio 2010）中處理項目后，我逐漸意識到XML注釋似乎對我來說是最好的。

我個人認為這在大多數IDE應用程序本身都是失敗的，例如，似乎Visual Studio實際上只支持C＃應用程序的XML注釋來提供Intellisense等功能，以及不那么花哨的語法突出顯示。 我發現有一個商業插件可用於在Visual Studio中“啟用”此功能，但為什么我應該支付尚未啟用的功能？

但是我與你原來的問題不同。 當我第一次研究這個時，似乎Apple自己必須使用Doxygen，因為他們似乎已經使用這個標准突出顯示代碼 。 話雖如此，這里有一些其他資源可以在其他應用程序中獲得相同的功能：

• Atomineer Pro文檔似乎是Visual Studio工作的工具，雖然我沒有親自使用它。 使用起來似乎相對簡單。
• Eclox似乎是Eclipse的前端插件，它實際上使用了Doxygen。 但是從我記憶中你應該能夠在C ++設置中調整IDE本身的語法高亮。
• Doxymacs在Emacs中維護一個符號表，以獲得一些快速搜索功能。
• 似乎在Vim項目頁面上有一個腳本可以為該編輯器處理它，它被稱為DoxygenToolkit 。

我絕對感覺到你的痛苦。 有一個溫暖和令人討厭的東西，讓夜間crontab生成干凈的文檔標記，很容易搜索。 我最近才開始尋找可用於實現這種跨平台的最佳機制。 從我收集的內容來看，大多數開發環境都支持各種類型的擴展，並且由於Doxygen基本上是“黃金標准”，如果它不是開箱即用的話，通常會有這樣或那樣的方式來提供支持。

如果您感興趣Doxygen實際上支持開箱即用的C＃XML注釋，但遺憾的是我無法在Xcode中使用它，而且我對AppleScript的熟悉程度不高。 但是如果你做的話請務必更新！