在Visual Studio中定制C#标准文档生成器（XML注释）

Question

• 是否有其他种类的文档生成器快捷方式适用于C＃（例如///生成function()代码）或任何工具项（例如电子邮件中的签名@ outlook）在VS IDE中，以遵循MS标准编码和文档并使其他共同开发人员理解正在开发的同一项目。
• 如何将生成的文档格式从visual stdio IDE更改为默认注释格式至下面显示的自定义注释格式。

示例：

 1. **Default Format**

     // Name:      
     // Author:     
     // Description: <summary></summary>    
     // Parameters: <param name="abc"></praram>  
     // Returned Value: <returns></returns>

 2. **New Custom Format**

     // Application:  <project></project>  <version></version> 
     // Created Developer: <developer></developer>
     // Created Date: <date></date>  
     // Last Modified:     
     // Last Modified Developer:     
     // Parameters: <param name="abc"></praram>      
     // Return Type: <returns></returns>    
     // Description: <summary></summary>

- Rahul Uttarkar

---

可能是更改Visual Studio中默认的XML注释片段的重复问题。 - DrewJordan

Answer 1

我不确定你的意思是替换掉 /// 注释，但是这里有很多选项可以选择，详见这个问题：

https://stackoverflow.com/questions/641364/c-sharp-documentation-generator

这里还有这些文章：

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx#id0400027

http://blogs.msdn.com/b/lisa/archive/2010/05/25/how-to-customize-the-xml-comments-that-are-inserted-by-the-visual-basic-code-editor.aspx

- John

---

我正在寻找对注释进行个性化定制的方法（标准文档生成器），就像其他设置（编辑器颜色，字体，标签关闭等）可以在VS中进行个性化定制一样。以同样的方式，我正在寻找设置预定义注释以便生成的方法。 - Rahul Uttarkar

@Rahul，请看一下那篇文章中的第二条评论，那里有很多可以让你自定义的工具。我们曾经使用过 Atomineer，它可以让你做很多自定义：http://www.atomineerutils.com/skins.php。我相信其中一些免费的工具也具有类似的功能。 - John

@Rahul刚刚更新了一些关于如何修改XML注释的文章。 - John

谢谢，我会尝试应用并观察效果。 - Rahul Uttarkar

在VS IDE中是否存在像注释和取消注释工具这样的工具项。当我点击它时，它会向我的代码添加预定义的注释..？这有助于我维护编码的标准。 - Rahul Uttarkar

我实际上正在尝试找到一种工具，就像在电子邮件中添加签名一样，为我的代码添加注释。 - Rahul Uttarkar

Answer 2

其中一个可以让您自定义默认XML注释的工具是VSdocman。您可以为每个代码元素类型（方法、属性等）甚至特定名称或类型预定义注释。它被称为注释模板。然后在代码编辑器中，右键单击并选择“添加XML注释”。此外，您可以使用该工具从您的注释生成文档（HTML、CHM、docx、VS帮助等）。

- Peter Macej

Answer 3

虽然这篇文章已经超过6个月了，但我认为这篇问答：如何在Visual Studio中更改默认的XML注释片段可以帮助你达到目标。只需将自定义的注释结构添加到CDATA部分即可。

- DrewJordan