大多数人都知道Visual Studio使用/*代码块*/和//代码行来注释代码,
但是却没有规范的对代码中的函数、类等进行注释。
Visual Studio提供了创建代码报告的功能。其中用到的注释方法可以很
好的规范我们的注释,使代码可读性更好。
下面是其中的一些注释标记
先要用///注释然后加上下面的这些标记
- <summary></summary> 概括说明。
- <remarks></remarks> 备注。
- <param></param> 在方法声明的注释中使用以描述该方法的一个参数。
- <returns></returns> 在方法声明的注释中使用以描述返回值。
- <newpara></newpara> 在注释中开始一个新段落。
例子:
using System;
namespace HelloWorld
{
/// <summary>
/// Sample Hello World in C#
/// </summary>
public class HelloWorld
{
/// <summary>
/// Console Application Entry Point/// </summary>
/// <param name="args">Command Line Arguments</param>
/// <returns>Status code of 0 on successful run</returns>
public static int Main(string[] args)
{
System.Console.WriteLine("HelloWorld");
string name = System.Console.ReadLine();
return(0);
}
}
}