【发布时间】:2013-08-01 12:48:16
【问题描述】:
我们正在升级大量在 XML cmets 出现之前创建的 .Net 代码。
此代码包含许多直接位于适用代码成员上方的 cmets:
' 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
在这些 cmets 中封装了很多有价值的信息,我们希望通过 XML 注释来公开这些信息。
但是,我们只能手动转换这些 cmets,方法是首先插入 xml 注释模板(直接在成员上方键入“''”),然后在旧 cmets 之前添加 XML 注释指示符 (''') 并手动将它们移动到新的 XML 块中。这显然是非常低效的。
不幸的是,我们不能只使用嵌入在宏中的标准 XML 注释模板代码块,因为我们想要获取方法参数、返回值等。
VS2012 中是否有我们忽略的已知插件或功能?
【问题讨论】:
-
在 XML cmets 出现之前——出于好奇,它们是什么时候引入的?我以为他们一直都在。
-
2000 年代初(.net 1.0/1,VS2002/3)。 VB.Net 直到 VS2005 才引入正式的 XML cmets。
标签: c# .net vb.net visual-studio-2012 xml-comments