我已經證明這樣的功能:獲取的Visual Studio 2015年認識到Doxygen註釋
/**
* Does something useful
*/
int foo(Bar bar)
{
// my function
}
但是,當我在其他地方懸停功能的智能感知不顯示它。當我將它懸停在定義上時,我看到* Does something useful
,這也不正確(星星不應該在那裏)。 Doxygen運行正常,Eclipse會顯示文檔註釋,就像您期望的那樣。
我已經證明這樣的功能:獲取的Visual Studio 2015年認識到Doxygen註釋
/**
* Does something useful
*/
int foo(Bar bar)
{
// my function
}
但是,當我在其他地方懸停功能的智能感知不顯示它。當我將它懸停在定義上時,我看到* Does something useful
,這也不正確(星星不應該在那裏)。 Doxygen運行正常,Eclipse會顯示文檔註釋,就像您期望的那樣。
從版本2016.2開始,JetBrains ReSharper爲C++文件中的Doxygen文檔提供支持。從this blog post我引述:
Doxygen的無疑是在C++世界中的代碼 文檔最流行的格式和工具。 ReSharper C++現在可以理解Doxygen 的語法,並提供了幾個關鍵功能來方便編輯 文檔塊。
- 打字幫助有助於創建新註釋塊並保持現有結構的 結構。
- 代碼完成提示Doxygen命令及其附帶的簡短描述。
- 使用\ param命令引入的函數參數引用將由Find Usages報告,並且在使用Rename更改函數參數的名稱時將會更新。
- 當函數參數引用不解析爲現有函數參數時發出警告。
- 文檔生成:您現在可以爲C++聲明符,類和宏定義生成文檔。
- 快速文檔:文檔現在可以在C++中使用。文檔彈出窗口(綁定到Visual Studio方案中的Ctrl + Shift + F1或IntelliJ IDEA方案中的Ctrl + Q)將顯示Doxygen註釋塊中的文檔,或者如果未找到文檔,則顯示符號的簽名。
應當注意的是,這款產品是不是免費的,使用它,你需要購買一個許可證。
謝謝,但我認爲這有點貴。我可能花費的金額較小,但在這個價格下的一年後版本的訂閱模式對我來說不是一個解決方案,因爲我可能只會使用一些功能。 – allo
你好,你的意思是'DoxygenComments'的擴展,對不對?如果是這樣,我發現這個擴展是適用於VS 2010/2012/2013,不包括VS 2015,請檢查DoxygenComments下載頁面:https://marketplace.visualstudio.com/items?itemName=OleksandrManenko.DoxygenComments如果你有以前的VS版本在你的電腦上,你可以試試這個相同的功能。您可以將此問題報告給DoxygenComments開發人員以尋求更專業的支持。 –
我看到了這個,但它已經過時了,所以我甚至沒有嘗試過。我認爲VS應該展示沒有任何擴展的摘要,不是嗎?目前我只是想讓這個工作,即使像DoxygenComments這樣的東西真的很好。 – allo
是的,VS內置了註釋功能,對於C#代碼,你可以在定義前的行上輸入///,編輯器創建一個文檔註釋模板並填寫參數和其他信息,請檢查這個例如:https://1drv.ms/i/s!Atv5QNuFrncKgmXl_rTqrjpZ-tMW。對於VB,您可以使用註釋符號('):https://msdn.microsoft.com/en-us/library/bx185bk6.aspx。對於C++,可以使用他評論字符(/ *,* /和//):https://msdn.microsoft.com/en-us/library/k1dbk8bw。aspx –