C#文档XML标记有哪些

本篇内容介绍了“C#文档XML标记有哪些”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!

创新互联公司提供高防服务器、云服务器、香港服务器、成都移动机房

C#文档XML标记的介绍

:指示这行注释标识为Code

:指示多行注释标识为Code

:经常与连用,用来给出如何使用某些成员的例子。

:指明一个成员会抛出哪些异常,经常与cref属性连用。

:指明注释在哪些文件中,以及位置。

:用来定义表头,经常与连用

:内部使用,如。让用户有机会给注释文本加入其他的结构。

:说明参数的属性,编译器会检查参数的合法性。如果通不过,会在文档中产生!标识的警告。

:类似

:标明用于成员的代码存取的安全性。

:用于描述class或其它类型的描述性文字,不涉及具体细节(如果是这样,使用

)。

:描述方法或函数的返回值。

:指定一个链接。

:指定要出现在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://bzwzjz.com/article/ijipii.html