VS “XML 文档” 说明

VS “XML 文档” 说明
1、如何生成
（1）、在 Visual Studio 中生成“XML 文档”示例
在“解决方案资源管理器”中右击该项目，再单击“属性”。
打开“配置属性”文件夹，然后单击“生成”。
将“XML 文档文件”属性设置为 XMLsample.xml。
在“生成”菜单上单击“生成”。
XML 输出文件将出现在调试目录中。
（2）、从命令提示符生成“XML 文档”示例
若要生成示例 XML 文档，请在命令提示符处键入以下内容：
csc XMLsample.cs /doc:XMLsample.xml
若要查看生成的 XML，请键入下面的命令：
type XMLsample.xml
2、/doc 命令说明
（1）、/doc（处理文档注释）（C# 编译器选项）
/doc 选项允许在 XML 文件中放置文档注释。
/doc:file
（2）、参数 file
XML 的输出文件，由编译的源代码文件中的注释填充。
（3）、 备注
在源代码文件中，可处理以下内容之前的文档注释，并将其添加到 XML 文件中：
·         用户定义的类型，如 class、delegate 或 interface
·         成员，如字段、事件、属性或方法
包含 Main 的源代码文件首先输出到 XML。
若要将生成的 .xml 文件用于Intellisense功能，请使该 .xml 文件的文件名与要支持的程序集同名，然后确保该 .xml 文件放入与该程序集相同的目录中。这样，在 Visual Studio 项目中引用程序集时，也可找到该 .xml 文件。有关更多信息，请参见提供代码注释。
除非用 /target:module 进行编译，否则 file 将包含 标记，以指定包含编译输出文件的程序集清单的文件名。
（4）、说明：
/doc 选项适用于所有输入文件；或者，如果此选项是在“项目设置”中设置的，则适用于项目中的所有文件。若要禁用与特定的文件或代码段的文档注释相关的警告，请使用 #pragma warning。
 
 
 
有关从代码中的注释生成文档的方法，请参见建议的文档注释标记。
有关示例，请参见 “XML 文档”示例。
在 Visual Studio 开发环境中设置此编译器选项
1.       打开项目的“属性”页。
2.       修改“XML 文档文件”属性。
3、C# 编译器将代码中的文档注释