Название инструмента для комментариев к документации VB.NET

Как называется инструмент, который позволял коду VB.NET иметь встроенные комментарии документации (соответствующие комментариям документации C #), которые можно было извлечь с помощью этого инструмента?

Я просматриваю старый код; Эпоха Visual Studio 2005. Тривиальный пример:

'Form overrides dispose to clean up the component list.
'''  <summary>
'''  Summary of Dispose.
'''  </summary>
'''  <param name="disposing"></param>
Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
    If disposing Then                                                
        If Not (components Is Nothing) Then                          
            components.Dispose()                                     
        End If                                                       
    End If                                                           
    MyBase.Dispose(disposing)                                        
End Sub                                                              

Существовал сторонний бесплатный инструмент для создания документации (с открытым исходным кодом?), Интегрированный в меню Visual Studio.


person Heidelbergensis    schedule 25.06.2010    source источник


Ответы (4)


Разработчики также использовали nDoc. Это могло быть то, что использовалось в вашем проекте. Это бесплатно, а не от Microsoft. Он больше не используется, так как не поддерживается. И он больше ориентирован на C #. Но есть как минимум один вспомогательный инструмент VB. Возможно, это не то, что вы хотели бы использовать сейчас, но они могут соответствовать синтаксису комментариев, встроенных в ваш устаревший код.

И есть еще один инструмент с открытым исходным кодом от Microsoft, который называется VBCommenter.

person DOK    schedule 25.06.2010
comment
это может быть вспомогательный инструмент VB, vb-doc.sourceforge.net. Он действительно говорит, что он устарел с VB.NET 2005, но, возможно, старый код был создан в Visual Studio 2003, а не в Visual Studio 2005, как я думал. - person Heidelbergensis; 25.06.2010
comment
@Heidelbergensis Мне кажется, это был VS 2003. XML-документация была добавлена ​​непосредственно в VB в VS 2005, см. Что нового msdn.microsoft.com/en-us/library/we86c8x2 (VS.80) .aspx - person MarkJ; 25.06.2010

Sandcastle. Не уверен, что он включает в себя плагин VS, но быстрый поиск в Google обнаруживает несколько инструментов, например DocProject для его интеграции.

person STW    schedule 25.06.2010
comment
Это инструмент Microsoft, а не сторонний инструмент. Это тоже с середины 2006 года. - person Heidelbergensis; 25.06.2010
comment
Я обновил ссылку на сайт codeplex (с открытым исходным кодом), который более актуален. Он официально не поддерживается (фактически сторонний поставщик), и вы упомянули VS2005, поэтому вопрос о 2006 году не исключен (однако есть выпуск от июня 2010 года - версия 2.6.1062.1) - person STW; 25.06.2010


Я нашел это. Это был VBXMLDoc, позже переименованный в VBXC. Он не обновлялся с 2006 года. Он был бесплатным (не с открытым исходным кодом), а версия 1.0 должна была быть коммерческой (или условно-бесплатной). Но последней версией была бета 3, все еще бесплатная. Еще можно загрузить бета-версию 3. Добавление комментариев XML в код.

person Heidelbergensis    schedule 26.06.2010