C#从文档注释生成XML
示例
要从代码中的文档注释生成XML文档文件,请将该/doc选项与csc.exeC#编译器一起使用。
在VisualStudio2013/2015中的项目->属性->生成->输出中,选中XMLdocumentationfile复选框:
在构建项目时,编译器将生成一个XML文件,其名称与项目名称相对应(例如XMLDocumentation.dll->XMLDocumentation.xml)。
在另一个项目中使用程序集时,请确保XML文件与所引用的DLL在同一目录中。
这个例子:
/// <summary>
///数据类描述
/// </summary>
public class DataClass
{
/// <summary>
///名称属性说明
/// </summary>
public string Name { get; set; }
}
/// <summary>
///Foo功能
/// </summary>
public class Foo
{
/// <summary>
///此方法返回一些数据
/// </summary>
/// <param name="id">Id parameter</param>
/// <param name="time">Time parameter</param>
/// <returns>Data will be returned</returns>
public DataClass GetData(int id, DateTime time)
{
return new DataClass();
}
}在构建时生成此xml:
<?xml version="1.0"?>
<doc>
<assembly>
<name>XMLDocumentation</name>
</assembly>
<members>
<member name="T:XMLDocumentation.DataClass">
<summary>
Data class description
</summary>
</member>
<member name="P:XMLDocumentation.DataClass.Name">
<summary>
Name property description
</summary>
</member>
<member name="T:XMLDocumentation.Foo">
<summary>
Foo function
</summary>
</member>
<member name="M:XMLDocumentation.Foo.GetData(System.Int32,System.DateTime)">
<summary>
This method returning some data
</summary>
<param name="id">Id parameter</param>
<param name="time">Time parameter</param>
<returns>Data will be returned</returns>
</member>
</members>
</doc>