2017-09-28 42 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