开发注释是 // 帮助拓展代码
开发注释:辅助开发,对变量或者函数等代码的后续开发做的注释。
使用注释是 /// 帮助使用代码
使用注释:帮助使用,主要是对使用变量或函数等代码的使用调用做的注释。
开发注释:辅助开发,对变量或者函数等代码的后续开发做的注释。
例如,你定义了一个私有变量 private int coins; 不打算让外部访问该变量。但在开发过程中,需要一些提示。
//金币的数量
private int coins;
使用注释是 /// 帮助使用代码
使用注释:帮助使用,主要是对使用变量或函数等代码的使用调用做的注释。
例如上面的coins变量,我们打算让外部能访问。那么代码是public int
coins; 在这段代码前输入///
则Mono会自动根据变量名生成如下注释,summary是对下方代码的总结。
2.能根据该格式的注释自动生成文档
文档生成器
/// <summary>
/// The coins.
/// </summary>
public int coins;
之后你可以自己添加注释如
/// <summary>
/// 金币总数
/// </summary>
public int coins;
或者按行输入文本, <para></para> 代表一行
/// <summary>
/// <para>金币数</para>
/// <para>可以当钱花</para>
/// </summary>
public int coins;
函数也是同样的写法。
有函数如下
public void UseCoins(intnumber)
{
}
在函数前输入/// , 得到如下,其中
<
param
name
='number'> </param>代表一个参数
/// <summary>
/// Uses the coins.
/// </summary>
/// <param name='number'>
/// Number.
/// </param>
public void UseCoins(intnumber)
{
}
这么写的好处是:
1.调用时弹出注释,如下
2.能根据该格式的注释自动生成文档
文档生成器