java xml文件注释多行_C#的XML两种代码注释实例说明

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

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

1.普通多行注释,比如

/*

*多行注释

*/

2.Javadoc注释,比如

/**

*Javadoc注释

*/

当Java源文件编译的时候，Javadoc工具会读取源文件当中的Javadoc注释内容，并生成相应的HTML文档。供开发者参阅API相关的内容。

在C#中采用了另外一种形式，即XML。

为了能够在编译过程中生成XML文档，需要一种来标记来标注注释。即三根反斜杠。

下面是一个简单的例子:

namespace MyNameSpace

{

///

/// 这是一个普通的类

///

public class Person

{

///

/// 这是标识的ID

///

public string Id { get; protected set; }

///

/// 这是姓名

///

public string Name { get; set; }

///

/// 这是年龄

///

public int Age { get; set; }

///

/// 这是构造函数

///

/// ID

/// 姓名

/// 年龄

public Person(string id, string name, int age)

{

this.Id = id;

this.Name = name;

this.Age = age;

}

///

/// 介绍自己啦

///

public void IntroduceMyself()

{

Console.WriteLine("My name is {0}, My age is {1}", Name, Age);

}

///

/// 计算两者之和

///

/// 左操作数

/// 右操作数

/// 两者和

public int calculate(int a, int b)

{

return a + b;

}

///

/// 讲话啦

///

/// 讲的内容

public void saySomething(string msg)

{

Console.WriteLine(msg);

}

}

}

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

查看生成的XML文档:

MyNameSpace

这是一个普通的类

这是构造函数

ID

姓名

年龄

介绍自己啦

计算两者之和

左操作数

右操作数

两者和

讲话啦

讲的内容

这是标识的ID

这是姓名

这是年龄

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

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