在Visual Studio中自定义C#标准文档生成器(XML注释)

本文关键字：XML 注释 文档 Studio Visual 自定义 标准 | 更新日期: 2023-09-27 18:29:21

  • 在VS IDE中，是否有任何其他类型的C#文档生成器快捷方式（如///生成function()代码）或任何工具项（如电子邮件@outlook中的签名），用于以下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>

在Visual Studio中自定义C#标准文档生成器(XML注释)

不确定你的意思是否不是///注释，但这个问题有很多选项：

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

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

这已经有6个月的历史了，但我认为这个问题的答案是：在Visual Studio中更改默认的XML注释片段会让你到达你想要的位置。只需将你的自定义注释结构添加到CDATA部分，你就可以了。

相关文章：