前言
命名规范是体现一个程序员素质的基本要求,所以遵循命名规则是必须要做到的,对于杂乱无章显示出来的只是自己的不自信,这个时候就是要学习了!
.NET中命名规则
命名空间
命名空间一边规则如下(vs中使用 using 后面):
System.Collections.Generic;
System.Linq;
System.Text;
System.Threading.Tasks
使用Pascal大写方式,用逗号隔开逻辑成分。
类
类的命名原则是用名词或名词短语命名类,使用Pascal大写方式。减少类名中缩写的使用量,不要使用任何类前缀(比如C),不使用带下划线的字符。
public class UserDAL{}
变量
名称中个单词首字母均为大写。在内部范围中避免使用与外部范围中的名称相同的名称。若访问错误变量,则会产生错误结果,若变量与同一名称的关键字冲突,则必须在关键字前加适当的类型库以作标识。
LastRecord。
函数与方法
以动词开始,使用Pascal大写。不要使用带下划线的字符。
接口
使用名词或者名词短语,或描述行为的形容词来命名接口,使用Pascal大写。减少接口名中缩写的使用量,在接口名前加前缀I,表示这个类型是接口。
ICheck。
参数
使用描述性参数名。参数名应该有足够的描述性,这样大多数情况下参数名和它的种类可以用来确定命名参数。根据参数的意思来命名参数,而不是根据参数的种类来命名。
public Datetable SelectUser(Entity.User User)
属性
用名词或名词短语命名属性,属性与类型要一样。用于一个类型的名称相同的名字来命名属性是,就是这个属性的类型成为那个类型。
public class Control{}
代码书写格式规范
文件之中不得存在无规则的空行,比如说十个连续的空行。一般来讲函数与函数之间的空行为2-3行。
在函数体内部,在逻辑上独立的两个函数块可进行适当空行,一般为1-2行。
每个长度尽量避免超过屏幕宽度,应不超过80个字符。
金狼用公共过程或子程序去代替重复的功能代码。
使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。
避免采用过于复杂的条件测试。
避免过多的循环嵌套和条件嵌套。
一个函数不要超过200行。一个文件应避免超过2000行。
避免使用goto语句。
避免采用多赋值语句。
代码注释规范
代码注释是我们常用的技巧,一个好的程序的代码一定是不用其他人给你讲解你自己就能看懂的,注释就是帮助你完成此项工作。
.cs文件的注释
所有.cs文件开头都要加上注释,写明文件创建时间、作者、用途概述等。
// 创建者:任晓帅 (rxs)
// 时间:2018/3/10 15:19:25
// 文件名:ModifyPWD
// 描述:供学习使用
// 版本:V1.0.0
// 版权所有,归属个人
函数过程注释
所有函数体开头都要加上注释,所以注释使用.NET注释规范。
/// <summary>
/// 执行不带参数的增删改SQL语句或者存储过程
/// </summary>
/// <param name="cmdText"></param>
/// <param name="ct"></param>
/// <returns></returns>
常量变量注释
所有的常量变量,无论是全局还是局部使用的,凡是对代码整体起到关键性作用的都要加上注释。
/// <summary>
/// 当前线程指向的备份文件本地保存路径
/// </summary>
public string StorePath = '';
代码修改注释
当维护以前的程序代码时,需要在修改处的开始及结尾,加上自己的注释信息。
// 修改人:
// 时间:
// 修改说明: