XSharp

 

通过 -doc 编译器选项，可以在 XML 文件中添加文档注释。

语法

-doc:file  

参数

备注

在源代码文件中，可以处理以下内容之前的文档注释并将其添加到 XML 文件中：

 

•类、委托或接口等用户自定义类型

•诸如字段、事件、属性或方法等成员

 

包含 Main 的源代码文件会首先输出到 XML 中。

 

要将生成的 .xml 文件用于 IntelliSense 功能，请让 .xml 文件的文件名与要支持的程序集相同，然后确保 .xml 文件与程序集位于同一目录下。这样，当程序集在 Visual Studio 项目中被引用时，.xml 文件也会被找到。更多信息，请参阅 "提供代码注释"。

 

除非使用 -target:module 进行编译，否则文件将包含 <assembly></assembly> 标记，指定编译输出文件中包含程序集清单的文件名。

 

 

注意

-doc 选项适用于所有输入文件；如果在 "项目设置 "中设置，则适用于项目中的所有文件。要禁用与特定文件或代码部分的文档注释相关的警告，请使用 #pragma warning。

 

 

有关从代码中的注释生成文档的方法，请参阅文档注释的推荐标签。

 

要在 Visual Studio 开发环境中设置该编译器选项，请执行以下操作

 

1.打开项目的 "属性"页面.

2.点击 Build 选项卡

3.编辑 XML documentation file 属性.

4.查看属性页

 

有关如何通过编程设置该编译器选项的信息，请参阅 DocumentationFile。