Csharp中的注释

原文地址：http://www.dingos.cn/index.php?topic=854.0

 

【单行注释】以 // 开始，并以换行符结束

public class HelloWorld { static void Main (string[] args){ //输出消息到控制台 Console.WriteLine ("你好！"); } }

 

【多行注释】符号 /* */ 指示中间的语句是程序中的注释；多行注释以 /* 开始，以 */ 结束。

/* * HelloWorld.cs * 2007-5-8 * 第一个Csharp程序 */ public class HelloWorld { static void Main (string[] args){ Console.WriteLine ("你好！"); } }

 

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

public class HelloWorld { /// <summary> /// …… /// </summary> /// <param name="args">……</param> public static void main(String[ ] args) { System.out.println("你好！"); } }

 

【文档标签及作用】

预定义的标签	用处
<c>	将说明中的文本标记为代码
<code>	提供了一种将多行指示为代码的方法
<example>	指定使用方法或其他库成员的示例
<exception>	允许你指定可能发生的异常类
<include>	允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 XML XPath 语法来描述你的源代码中的类型和成员。
<list>	向XML注释文档中插入一个列表
<para>	向XML注释文档中插入一个段落
<param>	描述一个参数
<paramref>	提供了一种指示一个词为参数的方法
<permission>	允许你将成员的访问许可加入到文档中
<remarks>	用于添加有关某个类型的信息
<returns>	描述返回值
<see>	指定链接
<seealso>	指定希望在“请参见”一节中出现的文本
<summary>	类型或类型成员的通用描述
<value>	描述属性

 

【注释代码行】

• 在代码编辑器中突出显示希望将其转换为注释的代码块。
• 从“编辑”菜单中，选择“高级”，然后选择“注释部分”，或按 Ctrl+E，然后按 C。
  在文本编辑器工具栏上也有“注释部分”按钮。
• 代码编辑器在突出显示的代码块中的每行之前使用 //，将它转换为注释