2017-09-28 69 views
0

我目前正在評估爲我們的客戶生成API文檔的替代解決方案。目前我們使用自己的家庭釀造解決方案,並開始了一些研究。這是我遇到由Microsoft開發和使用的DocFX。DocFX(VB.net) - 支持內聯註釋

顯得很實用,除了有無處我可以看到提有關,包括內聯註釋,比如下面的例子事實:

Enum Test 
Value1= 0 ' This is a sample comment 
End Enum 

之所以需要這個,尤其是枚舉是這是怎麼了我們一直在將我們的意見公佈在文檔中。

+0

內註釋不被微軟的元數據發生器中提取,所以docfx將永遠無法將它們一一撿起。顯然Doxygen可以做到,但我沒有測試過它。 – Schwarzie2478

回答

0

下面是一個例子:

vb ''' <summary> ''' egg size enum ''' </summary> Public Enum EggSizeEnum ''' <summary> ''' jumbo ''' </summary> Jumbo ''' <summary> ''' extra large ''' </summary> ExtraLarge Large Medium Small End Enum