/// <Properties depiction>
/// </summary>
3.5 方法注释
在类的方法声明前必须以以下格式编写注释
/// <summary>
/// depiction:<对该方法的说明>
/// </summary>
/// <param name="<参数名称>"><参数说明></param>
/// <returns>
///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
/// </returns>
///Writer:作者中文名
///Create Date:<方法创建日期,格式:YYYY-MM-DD>
3.6 代码间注释
代码间注释分为单行注释和多行注释:
单行注释:
//<单行注释>
多行注释:
/*多行注释 1
多行注释 2
多行注释 3*/
代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明
此语句块的作用和实现手段(所用算法等等)。
4 命名总体规则
名字应该能够标识事物的特性。
名字一律使用英文单词,而不能为拼音。
名字尽量不使用缩写,除非它是众所周知的。
名字可以有两个或三个单词组成,但不应多于三个,控制在 3 至 30 个字母以内。
在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:
IsSuperUser。
名字尽量使用前缀而不是后缀。
名字中的单词尽量使用名词,如有动词,也尽量放在后面。例如:
FunctionUserDelete(而不是 FunctionDeleteUser)。
评论1
最新资源