DocFX(VB.net) - 支持内联评论

时间:2017-09-28 07:50:04

标签: vb.net docfx

我目前正在评估为客户生成API文档的替代解决方案。目前我们使用自己的自制解决方案,并开始进行一些研究。这是我遇到微软开发和使用的DocFX的时候。

似乎非常有用,除了我无处可见的事实,我可以看到包含内联注释,例如以下示例:

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

要求这样做的原因,特别是对于枚举,这就是我们如何将我们希望在文档中公开显示的评论。

1 个答案:

答案 0 :(得分:1)

以下是一个例子:

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