详解C#文档XML标记

C#文档XML标记是我们在C#文档制作的时候必须要使用的，那么关于C#文档XML标记的各种标记的属性是如何的呢？我们使用中会有什么特点呢？那么让我们来具体看看。

创新互联-专业网站定制、快速模板网站建设、高性价比佛坪网站开发、企业建站全套包干低至880元,成熟完善的模板库,直接使用。一站式佛坪网站制作公司更省心,省钱,快速模板网站建设找我们，业务覆盖佛坪地区。费用合理售后完善，十多年实体公司更值得信赖。

C#文档XML标记的介绍

：指示这行注释标识为Code
 
：指示多行注释标识为Code
 
：经常与连用，用来给出如何使用某些成员的例子。
 
：指明一个成员会抛出哪些异常，经常与cref属性连用。
 
：指明注释在哪些文件中，以及位置。
 
：用来定义表头，经常与连用
 
：内部使用，如或。让用户有机会给注释文本加入其他的结构。
 
：说明参数的属性，编译器会检查参数的合法性。如果通不过，会在文档中产生!标识的警告。
 
：类似。
 
：标明用于成员的代码存取的安全性。
 
：用于描述class或其它类型的描述性文字，不涉及具体细节（如果是这样，使用

）。
 
：描述方法或函数的返回值。
 
：指定一个链接。
 
：指定要出现在See Also部分的文本。
 
：类型的描述性文字。它会被vs.net内置的IntelliSense使用并显示在对应的类型中。（即在vs.net中击键“.”出现的提示）
 
：描述属性。

标记及描述
 
cref：可用于任何标记来提供一个代码元素的参考。编译器将检查这个代码元素是否存在，如不存在则在文档中用!标识。
 
name：用于或

C#文档XML标记使用的例子

1.标记

 
 
 
      
  
  
  1. ///   
    2.   
  
  
  2.  
    3.   
  
  
  3. /// A method with a string array param.  
    4.   
  
  
  4.  
    5.   
  
  
  5. /// 
  
  •  
  • ///   
  •  
  • public void Koo(string[] ss) {}  

    • 2.标记

     
 
 
        
  
  
    1. ///   
      2.   
  
  
    2.  
      3.   
  
  
    3. /// A nonvoid method.  
      4.   
  
  
    4.  
      5.   
  
  
    5. /// 
      
  •  
  • /// The result of the operation.  
  •  
  • public int Noo() { return 0; }  

    • 3.标记和cref 属性：

     
 
 
        
  
  
    1. ///   
      2.   
  
  
    2.  
      3.   
  
  
    3. ///   
      4.   
  
  
    4.  
      5.   
  
  
    5. /// Throws a FileIOException when...  
      6.   
  
  
    6.  
      7.   
  
  
    7. ///   
      8.   
  
  
    8.  
      9.   
  
  
    9. ///   
      10.   
  
  
    10.  
      11.   
  
  
    11. public void Foo() {} 
      12.

    4., , 和标记

     
 
 
        
  
  
    1. ///   
      2.   
  
  
    2.  
      3.   
  
  
    3. /// Hoo is a method in the Class1 class.  
      4.   
  
  
    4.  
      5.   
  
  
    5. ///   
      6.   
  
  
    6.  
      7.   
  
  
    7. public void Hoo() {}  
      8.   
  
  
    8.  
      9.   
  
  
    9.    
      10.   
  
  
    10.  
      11.   
  
  
    11. ///   
      12.   
  
  
    12.  
      13.   
  
  
    13. /// The Joo method.  
      14.   
  
  
    14.  
      15.   
  
  
    15. /// This example shows how to use Joo:  
      16.   
  
  
    16.  
      17.   
  
  
    17. ///   
      18.   
  
  
    18.  
      19.   
  
  
    19. ///   
      20.   
  
  
    20.  
      21.   
  
  
    21. /// public static void Main()  
      22.   
  
  
    22.  
      23.   
  
  
    23. /// {  
      24.   
  
  
    24.  
      25.   
  
  
    25. ///     Console.WriteLine(Class1.Joo());  
      26.   
  
  
    26.  
      27.   
  
  
    27. /// }  
      28.   
  
  
    28.  
      29.   
  
  
    29. ///   
      30.   
  
  
    30.  
      31.   
  
  
    31. ///   
      32.   
  
  
    32.  
      33.   
  
  
    33. ///   
      34.   
  
  
    34.  
      35.   
  
  
    35. ///   
      36.   
  
  
    36.  
      37.   
  
  
    37. public static int Joo() { return 0; }  
      38.

    5. 标记语法：

     
 
 
        
  
  
    1.   
      2.   
  
  
    2.  
      3.   
  
  
    3.    
      4.   
  
  
    4.  
      5.   
  
  
    5. ///   
      6.   
  
  
    6.  
      7.   
  
  
    7. class Class1{  
      8.   
  
  
    8.  
      9.   
  
  
    9. public static void Main() {}  
      10.   
  
  
    10.  
      11.   
  
  
    11. }  
      12.   
  
  
    12.  
      13.   
  
  
    13. supporting.xml  
      14.   
  
  
    14.  
      15.   
  
  
    15.   
      16.   
  
  
    16.  
      17.   
  
  
    17.       
      18.   
  
  
    18.  
      19.   
  
  
    19.           
      20.   
  
  
    20.  
      21.   
  
  
    21.         The summary for this type.  
      22.   
  
  
    22.  
      23.   
  
  
    23.           
      24.   
  
  
    24.  
      25.   
  
  
    25.       
      26.   
  
  
    26.  
      27.   
  
  
    27.       
      28.   
  
  
    28.  
      29.   
  
  
    29.           
      30.   
  
  
    30.  
      31.   
  
  
    31.         Another type description.  
      32.   
  
  
    32.  
      33.   
  
  
    33.           
      34.   
  
  
    34.  
      35.   
  
  
    35.       
      36.   
  
  
    36.  
      37.   
  
  
    37.   
      38.

    6.标记语法及应用

     
 
 
        
  
  
    1.   
      2.   
  
  
    2.  
      3.   
  
  
    3.       
      4.   
  
  
    4.  
      5.   
  
  
    5.         term  
      6.   
  
  
    6.  
      7.   
  
  
    7.         description  
      8.   
  
  
    8.  
      9.   
  
  
    9.       
      10.   
  
  
    10.  
      11.   
  
  
    11.       
      12.   
  
  
    12.  
      13.   
  
  
    13.         term  
      14.   
  
  
    14.  
      15.   
  
  
    15.         description  
      16.   
  
  
    16.  
      17.   
  
  
    17.       
      18.   
  
  
    18.  
      19.   
  
  
    19.   
      20.   
  
  
    20.  
      21.   
  
  
    21.    
      22.   
  
  
    22.  
      23.   
  
  
    23. /// Here is an example of a bulleted list:  
      24.   
  
  
    24.  
      25.   
  
  
    25. ///   
      26.   
  
  
    26.  
      27.   
  
  
    27. ///   
      28.   
  
  
    28.  
      29.   
  
  
    29. /// Item 1.  
      30.   
  
  
    30.  
      31.   
  
  
    31. ///   
      32.   
  
  
    32.  
      33.   
  
  
    33. ///   
      34.   
  
  
    34.  
      35.   
  
  
    35. /// Item 2.  
      36.   
  
  
    36.  
      37.   
  
  
    37. ///   
      38.   
  
  
    38.  
      39.   
  
  
    39. ///   
      40.   
  
  
    40.  
      41.   
  
  
    41. ///   
      42.   
  
  
    42.  
      43.   
  
  
    43. static void Main(string[] args) {}  
      44.

    C#文档XML标记的基本内容就向你介绍到这里，希望对你了解和学习C#文档XML标记有所帮助。

    【编辑推荐】

    1. C#调用浏览器的原理及实现浅析
    2. C#文件浏览器制作的详细过程
    3. C#货币格式转化实例解析
    4. 浅析C#文档自动化实现
    5. C#文档输出的类型描述符浅析

    网站标题：详解C#文档XML标记
    标题路径：http://www.zyruijie.cn/qtweb/news19/10419.html

    网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

    广告

    声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

    猜你还喜欢下面的内容

    标签优化知识

    同城分类信息

    成都画册设计　　 　胜锦安防科技　　 　合江网站建设　　 　服务器托管　　 　成都富士康招工　　 　网站空间　　 　名片　　 　成都网站推广　　 　成都免费做网站　　 　重庆移动网站建设　　 　网页改版　　 　平昌做网站　　 　电商网店　　 　软文发布平台　　 　信衡房屋鉴定　　 　成都IDC机房托管　　 　成都做网站　　 　移动网站建设　　 　成都服务器租用　　 　梦港之夜