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

Question

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

似乎非常有用，除了我看不到任何地方提到包含内联注释的事实，例如以下示例：

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

要求这样做的原因，特别是对于枚举，这是我们一直在将我们希望在文档中公开可见的评论的方式。

Answer 1

这是一个例子：

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