В настоящее время я оцениваю альтернативные решения для создания документации API для наших клиентов. В настоящее время мы используем собственное домашнее решение, и я начал некоторые исследования. Это было, когда я столкнулся с DocFX, разработанным и используемым Microsoft.
Выглядело очень полезно, за исключением того факта, что я нигде не видел упоминания о включении встроенных комментариев, таких как следующий пример:
Enum Test
Value1= 0 ' This is a sample comment
End Enum
Причина, по которой это требуется, особенно с перечислениями, заключается в том, как мы помещаем наши комментарии, которые мы хотим сделать общедоступными в документации.