C#的XML两种代码注释实例说明

 更新时间:2012年12月19日 09:18:23   作者:  
在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾,本文将详细介绍,需要的朋友可以参考下

在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾。

在Java中,多行注释(Multiline Comment)分为两种形式:

1.普通多行注释,比如

复制代码 代码如下:

/*
*多行注释
*/

2.Javadoc注释,比如
复制代码 代码如下:

/**
*Javadoc注释
*/

当Java源文件编译的时候,Javadoc工具会读取源文件当中的Javadoc注释内容,并生成相应的HTML文档。供开发者参阅API相关的内容。
在C#中采用了另外一种形式,即XML。
为了能够在编译过程中生成XML文档,需要一种来标记来标注注释。即三根反斜杠。
下面是一个简单的例子:
复制代码 代码如下:

namespace MyNameSpace
{
/// <summary>
/// 这是一个普通的类
/// </summary>
public class Person
{
/// <summary>
/// 这是标识的ID
/// </summary>
public string Id { get; protected set; }
/// <summary>
/// 这是姓名
/// </summary>
public string Name { get; set; }
/// <summary>
/// 这是年龄
/// </summary>
public int Age { get; set; }

/// <summary>
/// 这是构造函数
/// </summary>
/// <param name="id">ID</param>
/// <param name="name">姓名</param>
/// <param name="age">年龄</param>
public Person(string id, string name, int age)
{
this.Id = id;
this.Name = name;
this.Age = age;
}
/// <summary>
/// 介绍自己啦
/// </summary>
public void IntroduceMyself()
{
Console.WriteLine("My name is {0}, My age is {1}", Name, Age);
}
/// <summary>
/// 计算两者之和
/// </summary>
/// <param name="a">左操作数</param>
/// <param name="b">右操作数</param>
/// <returns>两者和</returns>
public int calculate(int a, int b)
{
return a + b;
}
/// <summary>
/// 讲话啦
/// </summary>
/// <param name="msg">讲的内容</param>
public void saySomething(string msg)
{
Console.WriteLine(msg);
}
}
}

编译该文件:  csc /doc:test.xml test.cs

查看生成的XML文档:

复制代码 代码如下:

<?xml version="1.0"?>
<doc>
<assembly>
<name>MyNameSpace</name>
</assembly>
<members>
<member name="T:MyNameSpace.Person">
<summary>
这是一个普通的类
</summary>
</member>
<member name="M:MyNameSpace.Person.#ctor(System.String,System.String,System.Int32)">
<summary>
这是构造函数
</summary>
<param name="id">ID</param>
<param name="name">姓名</param>
<param name="age">年龄</param>
</member>
<member name="M:MyNameSpace.Person.IntroduceMyself">
<summary>
介绍自己啦
</summary>
</member>
<member name="M:MyNameSpace.Person.calculate(System.Int32,System.Int32)">
<summary>
计算两者之和
</summary>
<param name="a">左操作数</param>
<param name="b">右操作数</param>
<returns>两者和</returns>
</member>
<member name="M:MyNameSpace.Person.saySomething(System.String)">
<summary>
讲话啦
</summary>
<param name="msg">讲的内容</param>
</member>
<member name="P:MyNameSpace.Person.Id">
<summary>
这是标识的ID
</summary>
</member>
<member name="P:MyNameSpace.Person.Name">
<summary>
这是姓名
</summary>
</member>
<member name="P:MyNameSpace.Person.Age">
<summary>
这是年龄
</summary>
</member>
</members>
</doc>

如果是在VISUAL STUDIO,需在项目属性的生成选项卡中选中生成XML文件,并指定路径和文件名。


这样,当您在使用相应的类或者方法时,我们利用IDE自带的提示工具查看该类或该方法的简要:


相关文章

  • Unity2D实现游戏回旋镖

    Unity2D实现游戏回旋镖

    这篇文章主要为大家详细介绍了Unity2D实现游戏回旋镖,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • C#日期格式强制转换方法(推荐)

    C#日期格式强制转换方法(推荐)

    下面小编就为大家分享一C#日期格式强制转换的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2017-11-11
  • c#使用dynamic类型优化反射的方法

    c#使用dynamic类型优化反射的方法

    dynamic是FrameWork4.0的新特性,下面这篇文章主要给大家介绍了关于c#使用dynamic类型优化反射的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-12-12
  • c#获取当前年的周数及当前月的天数示例代码

    c#获取当前年的周数及当前月的天数示例代码

    本篇文章主要是对c#获取当前年的周数及当前月的天数示例代码进行了介绍,需要的朋友可以过来参考下,希望对大家有所帮助
    2014-01-01
  • c#求范围内素数的示例分享(c#求素数)

    c#求范围内素数的示例分享(c#求素数)

    问题是判断101-200之间有多少个素数,并输出所有素数。下面是使用C#解决这个问题的方法 ,需要的朋友可以参考下
    2014-03-03
  • 在C#中根据HardwareID获取驱动程序信息的实现代码

    在C#中根据HardwareID获取驱动程序信息的实现代码

    这篇文章主要介绍了C#中根据HardwareID获取驱动程序信息的实现代码,需要的朋友可以参考下
    2016-12-12
  • C#文件路径Path类介绍

    C#文件路径Path类介绍

    这篇文章介绍了C#中的文件路径Path类,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-05-05
  • C#实现发送邮件的方法

    C#实现发送邮件的方法

    这篇文章主要为大家详细介绍了C#实现发送邮件的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-09-09
  • C# HttpClient 如何使用 Consul 发现服务

    C# HttpClient 如何使用 Consul 发现服务

    这篇文章主要介绍了C# HttpClient 如何使用 Consul 发现服务,帮助大家更好的理解和使用c#,感兴趣的朋友可以了解下
    2021-02-02
  • C#中Dictionary的作用及用法讲解

    C#中Dictionary的作用及用法讲解

    这篇文章主要介绍了C#中Dictionary的作用及用法讲解,本文还对dictionary类用什么接口实现、Dictionary的基本用法做了讲解,需要的朋友可以参考下
    2014-10-10

最新评论