Мы находимся в процессе обновления большого количества .Net-кода, который был создан до появления комментариев XML.Генерировать комментарии XML из регулярных комментариев
Этот код содержит много комментариев, которые либо непосредственно над действующим элементом кода:
' This property returns true if ...
Public ReadOnly Property ReturnTrueIf As Boolean
или в формате «старой школы», что я думаю, что было использовано автоматических составителей документации как Сандкасл:
'===================================================
' Class Description:
' Description of this class
'
' Remarks:
' Some remarks about this class.
'
Public Class SomeClass
В этих комментариях содержится ценная информация, которую мы хотели бы выразить посредством комментариев XML.
Однако мы смогли только преобразовать эти комментарии вручную, сначала вставив шаблон комментария xml (набрав '' 'непосредственно над членом), затем добавив индикаторы комментария XML (' '') перед старыми комментариями и вручную перемещая их в новый блок XML. Это, очевидно, очень неэффективно.
К сожалению, мы не можем просто использовать стандартный блок XML комментарий шаблона кода, встроенный в макросе, так как мы хотим, чтобы пикап параметров метода, возвращаемые значения и т.д.
Существуют ли какие-либо известные Addins или функциональные запеченные в VS2012, что мы не замечаем?
_prior до появления XML-комментариев_ - из любопытства, когда они были введены? Я думал, они всегда там. –
В начале 2000-х годов (.net 1.0/1, VS2002/3). Формальные комментарии XML не были введены в VB.Net до VS2005. –