在 Eclipse 中更改 doxygen 注釋樣式

Question

有誰知道如何在 Eclipse CDT 中編輯用於 Doxygen 注釋的樣式？

換句話說，在當前函數之前輸入/** 並在一行上按Enter 鍵，我會得到如下內容：

/**
 * 
 * @param one
 * @param two
 * @return
 */
Foo(int one, int two);

我希望它給我類似的東西：

/**********************************************************************/
///
/// \param one
/// \param two
/// \return
/***********************************************************************/
Foo(int one, int two);

另外，如果有人知道如何將其綁定到鍵盤快捷鍵（如 Eclipse JDT 的alt - shift - j ），請加一個。

另外，僅供參考，Eclipse CDT 支持 Doxygen 的事實現在似乎是基於 Google 的一個鮮為人知的事實。 有關詳細信息，請參見此處。 通過在“C/C++ 常規”選項卡中選擇“啟用項目特定設置”並選擇“Doxygen”，可以在項目屬性下啟用 Doxygen。 我的 CDT 版本是 7.0.1，但我認為它在 5.0 中可用。

最后，根據我的測試，首選項中代碼模板下的注釋部分沒有實現這一點。

編輯：見這里。 似乎評論風格是硬編碼的。 如果有人發現其他情況，我很想知道。 我想模板將是現在最好的東西，除非 Javadoc 風格適合你。

Answer 1

是的，這似乎是 Eclipse CDT 中的一個錯誤。

作為一種解決方法，我建議您創建一個可以使用Ctrl + Space組合鍵訪問的自定義模板。

在 Eclipse Helios 中：窗口 -> 首選項 -> C/C++ -> 編輯器 -> 模板

單擊New...創建一個新模板，並在Name字段中使用一些描述性名稱，例如“comment-function”，並在Pattern字段中添加您的 doxygen 注釋。 確認並應用此更改。

在您的代碼中，您可以轉到函數聲明上方的行，鍵入自定義模板名稱的前幾個字母，然后按Ctrl + Space組合鍵。

在這個例子中：

com<Ctrl+space>

將調出用“com*”過濾的“內容輔助”對話框，您可以從中選擇“注釋功能”模板。

筆記：

com<Ctrl+space+space>

將通過僅在 Content Assist 彈出窗口中顯示模板建議來進一步過濾。

Answer 2

這是我在我的 java 評論中找到的配置

當我如圖所示編輯時，我的 Java 文檔注釋更改為

嘗試在您的 php 配置下尋找類似的配置。

Answer 3

我可以通過以下方式獲得一些您想要的方式：首選項 - PHP - 代碼樣式 - 代碼模板 - 注釋。

我不確定這是否能讓您對關鍵字使用反斜杠而不是 @s，但我認為它應該可以實現您想要的大部分內容。

Answer 4

從 eclipse 2020-03 開始​​，您可以使用以下選項的組合：代碼模板使用 /*****/ 創建頁眉和頁腳，然后在中間使用 /// 在 C/C++->Editor 中自定義樣式選項。

Answer 5

Doxygen 標簽使用這種基本格式。

/**
Your tags and such. It MUST have the /** and the */.
*/

它絕對必須在整個 Doxygen 注釋周圍有 /** */ 。 如果您修改代碼模板，它將執行您想要的操作。

不過，建議的評論風格是錯誤的。

/***************/ <-- These are terminated Doxygen blocks.
/// <-- These are used in xml style Doxygen blocks.
///
/// This isn't actually a Doxygen block and shouldn't work
/// if you run Doxygen on it.
///
/***************/ <-- These are terminated Doxygen blocks.

以下是大多數使用 JAVA 和 eclipse 編碼的公司的標准。 由於 Doxygen 對多種語言有效，因此對 C/C++ 也有效。

/**
 * Brief description.
 *
 * @param[in|out] <value> <description>
 */

如果要使用 xml 樣式標簽...

/// <summary>
/// This is a summary of the class, blah, blah.
/// </summary>

您還需要確保 eclipse 也不會插入其他注釋樣式，否則您最終可能會在其他注釋中插入注釋。 通常，將 /** */ 和 /// 之類的注釋樣式混合在一起也是一個不好的規則。

最后，如果您在創建類時選擇自動生成注釋，這些注釋將自動放入。並且您可以在鍵入時使用 Eclipse 自動生成方法標題（盡管我忘記了我是如何做到的）。