在C#使用XML注释

原创 2004年06月13日 16:11:00

简介<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

大多数程序员可能都听说过Java自带的一个工具JavaDoc;使用它可以自动地为你的代码生成HTML文档。C#和C#编译器也有类似的功能,不过它生成的是XML,而不是直接生成HTML。不过使用XML会使得文档更加灵活。

注释语法

       为了使用C#提供的XML注释功能,你的注释应该使用特殊的注释语法(///)开头。在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。

预定义的标签            用处

<c>                             将说明中的文本标记为代码

<code>                       提供了一种将多行指示为代码的方法

<example>                  指定使用方法或其他库成员的示例

<exception>         允许你指定可能发生的异常类

<include>                           允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 XML XPath 语法来描述你的源代码中的类型和成员。

<list>                           XML注释文档中插入一个列表

<para>                        XML注释文档中插入一个段落

<param>                     描述一个参数

<paramref>                 提供了一种指示一个词为参数的方法

<permission>              允许你将成员的访问许可加入到文档中

<remarks>                  用于添加有关某个类型的信息

<returns>                    描述返回值

<see>                         指定链接

<seealso>                   指定希望在请参见一节中出现的文本

<summary>                 类型或类型成员的通用描述

<value>                描述属性

 

例子

下面的例子为我们常见的HelloWorld控制台应用程序添加注释:

using System;

namespace HelloWorld
{
    /// <summary>
    /// Sample Hello World in C#
    /// </summary>
    public class HelloWorld
    {
        /// <summary>
        /// Console Application Entry Point
        /// <param name="args">Command Line Arguments</param>
        /// <returns>Status code of 0 on successful run</returns>
        /// </summary>
        public static int Main(string[] args)
        {
            System.Console.WriteLine("HelloWorld");
            string name = System.Console.ReadLine();

            return(0);
        }
    }
}

为生成XML注释文档,我们在调用csc编译源代码时使用/doc选项:

csc /doc:HelloWorld.xml helloworld.cs

       生成的结果文档如下:

<?xml version="1.0"?>

<doc>

    <assembly>

        <name>XMlComment</name>

    </assembly>

    <members>

        <member name="T:HelloWorld.HelloWorld">

            <summary>

            Sample Hello World in C#

            </summary>

        </member>

        <member name="M:HelloWorld.HelloWorld.Main(System.String[])">

            <summary>

            Console Application Entry Point

            <param name="args">Command Line Arguments</param>

            <returns>Status code of 0 on successful run</returns>

            </summary>

        </member>

    </members>

</doc>

 

HTML页面

你可能会问自己:我应该如何才能得到具有良好格式的HTML页面呢?很简单,你可以编写自己的XSL来转换生成的XML注释文档,或者使用Visual Studio.NET开发工具。通过使用VS.NET的【工具】菜单中的【生成注释web页】,你可以得到一系列详细说明你的项目或解决方案的HTML页面。下面就是通过VS.NET生成的注释helloWorld程序的HTML页面快照:

C#的XML代码注释

在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾。 在Java中,多行注释(Multiline Comment)分为两种形式: ...
  • czjuttsw
  • czjuttsw
  • 2012年12月18日 19:38
  • 3593

Visual C# 中智能提示(XML注释)的使用(含注释在开发时显示换行)

Visual C# 中XML注释的使用(含注释在开发时显示换行)在C#智能注释时,常常希望它能在开发时显示为换行,使得提示更加友好!原来一直想怎么实现,今天偶然发现原来如此简单,只需将 标记用于诸如 ...
  • wonsoft
  • wonsoft
  • 2009年01月02日 17:30
  • 5530

使用.NET中的XML注释(一) -- XML注释标签讲解

摘要   .Net允许开发人员在源代码中插入XML注释,这在多人协作开发的时候显得特别有用。 C#解析器可以把代码文件中的这些XML标记提取出来,并作进一步的处理为外部文档。 这篇文章将展示如何使...
  • pengpegV5yaya
  • pengpegV5yaya
  • 2015年08月25日 21:32
  • 1456

使用.NET中的XML注释(一) -- XML注释标签讲解

摘要   .Net允许开发人员在源代码中插入XML注释,这在多人协作开发的时候显得特别有用。 C#解析器可以把代码文件中的这些XML标记提取出来,并作进一步的处理为外部文档。 这篇文章将展示如何使...
  • pengpegV5yaya
  • pengpegV5yaya
  • 2015年08月25日 21:32
  • 1456

android XML文件注释

android的XML文件注释一般采用 的方式进行,但是有时候却不能进行注释,如 ...
  • KKKDING
  • KKKDING
  • 2013年02月27日 10:57
  • 29366

Android中,xml代码注释注意事项

本文转载自:http://blog.csdn.net/pipisorry/article/details/24833325 怎么在android的XML文件中添加注释 Android的...
  • u012138032
  • u012138032
  • 2016年11月09日 13:31
  • 3625

C#提供的XML注释功能的预定义的标签

简介 大多数程序员可能都听说过Java自带的一个工具JavaDoc;使用它可以自动地为你的代码生成HTML文档。C#和C#编译器也有类似的功能,不过它生成的是XML,而不是直接生成HTML。不过...
  • jsm8523
  • jsm8523
  • 2013年08月17日 13:36
  • 574

C#来创建和读取XML文档

扩展标记语言XML(eXtensible Markup Language),是由W3C组织制定的。做为用于替代HTML语言的一种新型的标记语言,XML内部有着很多基本标准,XML就是通过与这些相关标准...
  • beyondqd
  • beyondqd
  • 2011年08月22日 15:20
  • 854

C#创建和读取XML文档

扩展标记语言XML(eXtensible Markup Language),是由W3C组织制定的。做为用于替代HTML语言的一种新型的标记语言,XML内部有着很多基本标准,XML就是通过与这些相关标准...
  • x415831943
  • x415831943
  • 2012年04月07日 01:16
  • 245

私人保险柜(xml,winform,c#)

  • 2007年11月26日 16:02
  • 3.94MB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:在C#使用XML注释
举报原因:
原因补充:

(最多只允许输入30个字)