DocFX (VB.net) — поддержка встроенных комментариев

В настоящее время я оцениваю альтернативные решения для создания документации API для наших клиентов. В настоящее время мы используем собственное домашнее решение, и я начал некоторые исследования. Это было, когда я столкнулся с DocFX, разработанным и используемым Microsoft.

Выглядело очень полезно, за исключением того факта, что я нигде не видел упоминания о включении встроенных комментариев, таких как следующий пример:

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

Причина, по которой это требуется, особенно с перечислениями, заключается в том, как мы помещаем наши комментарии, которые мы хотим сделать общедоступными в документации.


person M. Hopper    schedule 28.09.2017    source источник
comment
Встроенные комментарии не извлекаются генератором метаданных Microsoft, поэтому docfx никогда не сможет их подобрать. По-видимому, Doxygen может это сделать, но я не проверял.   -  person Schwarzie2478    schedule 27.10.2017


Ответы (1)


Вот пример:

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