C#命名规范(一)

1.编码规范对于程序员而言尤为重要,有以下几个原因：

　　1.1.一个项目的生命周期中,80%的花费在于维护;

　　1.2.几乎没有任何一个项目,在其整个生命周期中,均由最初的开发人员来维护;

　　1.3.命名规范可以改善项目的可读性,可以让程序员尽快而彻底地理解新的代码;

　　1.4.如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,比如你已构建的其它任何产 品。 为了执行规范,每个软件开发人员必须一致遵守编码规范。

2.命名原则：

　　2.1.使名称足够长以便有一定的意义,并且足够短以避免冗长;

　　2.2.唯一名称在编程上仅用于将各项区分开;

　　2.3.表现力强的名称是为了帮助人们阅读。

3.sql文件命名规范：

　　3.1.命名顺序：

　　　　1.开头注释 2.文件名 3.创建人 4.日期 5.描述 6.版本

　　3.2.例:

　　　　//********************************************//

　　　　//**文件名:sp_CalcTask.sql

　　　　//**创建人:张三

　　　　//**日期:2017/08/13

　　　　//**描述:主要完成数据库自动计算任务

　　　　//**版本:1.4版本

　　　　//********************************************//

　　　　create proc sp_CalcTask(

　　　　　　@p_Time int,//时间周期

　　　　　　@p_AutoCalc bit //是否自动运算

　　　　) begin //TODO end

4.cs文件格式：

　　4.1.命名顺序：

　　　　1.开头注释 2.文件名 3.创建人 4.日期 5.描述 6.版本

　　4.2.例:

　　　　//********************************************//

　　　　//**文件名:RandomCreator.cs

　　　　//**创建人:张三

　　　　//**日期:2017/08/13

　　　　//**描述:主要完成随机数字的生成

　　　　//**版本:1.4版本

　　　　//********************************************//

　　　　usingSystem;

　　　　usingSystem.Collections.Generic;

　　　　usingSystem.Text; namespace COMM

　　　　{

　　　　　　public class RandomCreator

　　　　　　{

　　　　　　　　//TODO...

　　　　　　}

　　　　}

5.后端API标准格式：

　　5.1.命名顺序：

　　　　1.开头注释 2.文件名 3.创建人 4.日期 5.描述 6.版本

　　5.2.例:

　　　　/// <summary>

　　　　/// 服务调用处理函数

　　　　/// </summary>

　　　　/// <param name="userId">用户Id</param>

　　　　/// <param name="userName">用户姓名</param>

　　　　/// <returans>返回.. </returns>

　　　　///

　　　　public string UpdateUserInfo(string userId,string userName)

　　　　{

　　　　　　//TODO...

　　　 ? }