我们正在升级大量在 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
这些注释中封装了很多有值(value)的信息,我们希望通过 XML 注释公开这些信息。
但是,我们只能通过首先插入 xml 评论模板(直接在成员上方键入 '''),然后在旧评论之前添加 XML 评论指示符(''')并手动转换这些评论将它们移动到新的 XML block 中。这显然是非常低效的。
不幸的是,我们不能只使用嵌入在宏中的标准 XML 注释模板代码块,因为我们想要获取方法参数、返回值等。
VS2012 中是否有任何我们忽略的已知插件或功能?
最佳答案
(AFAIK)在任何版本的 VS 中都没有嵌入它。 可能在 Resharper、Coderush 或 Justcode 中有一些东西。
FWIW:我会去编写一个简单的应用程序,其中包含 Regex 魔法。
关于c# - 从常规注释生成 XML 注释,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17979782/