doxygen/**樣式創建虛假代碼塊並啓用降價

我們有一個大型C++項目，廣泛使用Doxygen。當Doxygen添加減價支持時，我們生成的文檔突然有了不需要的「裝箱」代碼塊，其中包含許多記錄的類和成員的第一條註釋行。禁用降價支持解決了問題，但我們希望能夠使用降價。doxygen/**樣式創建虛假代碼塊並啓用降價

問題顯然是我們對Doxygen評論使用/**風格。爲了簡潔起見，我們對同一行開始評論，特別是對於簡短的評論，並且我們不會在註釋的其餘部分縮進。我猜Doxygen把這個降價作爲一個縮進行來降價，所以markdown把它放在一個代碼塊中。評論這樣的做工精細：

/** This a short comment (works). */

但是這樣結束了意見，處理第一線，雖然它已被放置在一個代碼塊：

/** This is a somewhat longer comment that ended up 
being wrapped to a second line (first line treated as code). */

在以下任一方式重新格式化修復問題：

/** This is a somewhat longer comment that ended up 
    being wrapped to a second line (works). */ 

/** 
This is a somewhat longer comment that ended up 
being wrapped to a second line (works). */

我們有數以千計的在緊湊的形式記錄上面的類和成員，並希望能夠使降價不改變這種風格。有沒有辦法讓Doxygen不生成這些不需要的代碼塊？

我正在使用Doxygen 1.8.5。

來源

2013-12-09 Sherm

作爲一個實驗，我剛剛擴展了我的markdown-focused的doxygen INPUT的範圍，以包含大量的C++代碼。我沒有看到這個，但是接下來我們的C++註釋在左邊有一個前面的星號，所以這可能是第三種* does *工作的情況。對不起，這對您的問題沒有多大幫助，因此。 – Cheeseminer

我看到你的問題，我希望用戶實際上想要用代碼塊開始評論是非常罕見的。

在doxygen中改變它實際上很容易。如果你可以將這個文件作爲一個bug報告在這裏：https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen然後我會將修復程序推送給GitHub來處理這個bug。

來源

2013-12-10 18:31:09 doxygen

提交錯誤報告＃720477 - 謝謝！ – Sherm

doxygen/**樣式創建虛假代碼塊並啓用降價

回答

相關問題