从常规注释生成XML注释

时间:2013-07-31 19:59:27

标签: c# .net vb.net visual-studio-2012 xml-comments

我们正在升级在XML评论出现之前创建的大量.Net代码。

此代码包含许多注释,这些注释直接位于适用的代码成员之上:

' This property returns true if ...
Public ReadOnly Property ReturnTrueIf As Boolean

或我认为自动文档编译器(如sandcastle)使用的“旧学校”格式:

'===================================================
' Class Description:
'   Description of this class
'
' Remarks:
'   Some remarks about this class.
'
Public Class SomeClass

我们希望通过XML评论公开这些评论中包含的大量有价值的信息。

但是,我们只能通过首先插入xml注释模板(在成员正上方输入''')手动转换这些注释,然后在旧注释之前添加XML注释指示符(''')并手动将它们移动到新的XML块中。这显然效率很低。

不幸的是,我们不能只使用嵌入在宏中的标准XML注释模板代码块,因为我们想要拾取方法参数,返回值等。

我们忽视了VS2012中是否有任何已知的插件或功能?

1 个答案:

答案 0 :(得分:0)

(AFAIK)在任何版本的VS中都没有嵌入它。可能可能是Resharper,Coderush或Justcode中的东西 FWIW:我会去写一个带有Regex魔法的简单应用程序。

相关问题