一、介绍
在 Visual C# 中,可以通过以下方法为代码创建文档:紧接在源代码中 XML 标记引用的代码块的前面,使用特殊的注释字段包括 XML 标记。 例如:
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass{}
二、示例
实例1:
/// <summary>
/// 增加方法
/// </summary>
/// <param name="sql"></param>
/// <returns>受影响行数</returns>
public int Select(string sql)
{
conn.Open();
comm = new SqlCommand(sql,conn);
int row = comm.ExecuteNonQuery();
return row;
}
实例2:
/// <summary>
/// 增加
/// </summary>
/// <param name="us"></param>
/// <returns>受影响行数</returns>
public int Return(users us)
{
string sql = string.Format("insert into a(name,age) values('{0}','{1}')", us.name, us.age);
int row = Select(sql);//在调用Select的时候,可以看见注释,表明这个方法有什么用
return row;
}
三、操作方式
先写好函数或方法,然后在函数或方法的上一行输入“///”后,系统会自动出来…以及参数等,在补全说明即可。
四、作用
注释,在编写代码较多时,比如类、方法等等,能更快更效率的知道它们的作用。