C#文档XML标记有哪些
本篇内容介绍了“C#文档XML标记有哪些”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!
创新互联公司提供高防服务器、云服务器、香港服务器、成都移动机房等
C#文档XML标记的介绍
:指示多行注释标识为Code
连用,用来给出如何使用某些成员的例子。
:用来定义表头,经常与
:说明参数的属性,编译器会检查参数的合法性。如果通不过,会在文档中产生!标识的警告。
)。
:描述方法或函数的返回值。
:指定一个链接。
:指定要出现在See Also部分的文本。
:类型的描述性文字。它会被vs.net内置的IntelliSense使用并显示在对应的类型中。(即在vs.net中击键“.”出现的提示)
:描述属性。标记及描述
cref:可用于任何标记来提供一个代码元素的参考。编译器将检查这个代码元素是否存在,如不存在则在文档中用!标识。
name:用于或
C#文档XML标记使用的例子
1.标记
/// /// A method with a string array param. /// /// public void Koo(string[] ss) {}
2.标记
/// /// A nonvoid method. /// /// The result of the operation. public int Noo() { return 0; }
3.标记和cref 属性:
/// /// /// Throws a FileIOException when... /// /// public void Foo() {}
4., , 和标记
/// /// Hoo is a method in the Class1 class. /// public void Hoo() {} /// /// The Joo method. /// This example shows how to use Joo: /// /// /// public static void Main() /// { /// Console.WriteLine(Class1.Joo()); /// } /// ///
/// /// public static int Joo() { return 0; }
5. 标记语法:
/// class Class1{ public static void Main() {} } supporting.xml The summary for this type. Another type description.
6.标记语法及应用
term description -
term description /// Here is an example of a bulleted list: /// /// - ///
Item 1. /// /// - ///
Item 2. /// /// ///
static void Main(string[] args) {}
“C#文档XML标记有哪些”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识可以关注创新互联网站,小编将为大家输出更多高质量的实用文章!
分享名称:C#文档XML标记有哪些
标题来源:http://azwzsj.com/article/ijipii.html