C# 程序员参考
<summary>(C# 编程指南)
<summary>description</summary>
参数
description
对象的摘要。
备注
<summary> 标记应当用于描述类型或类型成员。使用 <remarks> 添加针对某个类型说明的补充信息。
<summary> 标记的文本是唯一有关 IntelliSense 中的类型的信息源,它也显示在对象浏览器中。
使用 /doc 进行编译可以将文档注释处理到文件中。
示例
C# 复制代码
// compile with: /doc:DocFileName.xml
/// text for class TestClass
public class TestClass
{
/// <summary>DoWork is a method in the TestClass class.
/// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
/// <seealso cref="TestClass.Main"/>
/// </summary>
public static void DoWork(int Int1)
{
}
/// text for Main
static void Main()
{
}
}
本文介绍了C#中的文档注释用法,包括<summary>和<remarks>标记的应用,以及如何通过/doc选项将注释编译到XML文件中。提供了示例代码展示如何为类和方法编写描述性注释。
395

被折叠的 条评论
为什么被折叠?



