你的位置:首页 > 软件开发 > ASP.net > 代 码 设 计 规 范

代 码 设 计 规 范

发布时间:2016-07-26 09:00:06
一、注释规范1、自建代码文件注释 对于自己创建的代码文件(如函数、脚本),在文件开头,一般编写如下注释:/*************************************************作者:说明:创建日 ...

一、注释规范

1、自建代码文件注释          

对于自己创建的代码文件(如函数、脚本),在文件开头,一般编写如下注释:

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

作者:

说明:

创建日期:

版本号:

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

2、标准注释 

在模块、类、属性、方法前一行添加注释,以便调用的时候提示用户,下以方法声明做例子:

       ///<summary>

      ///<对该方法的说明>

      ///</summary>

      ///<paramname="<参数名称>"><参数说明></param>

   ///<returns>

     ///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>

     ///</returns>

3、代码中的注释

  代码间注释分为单行注释和多行注释:

  单行注释:

      //<单行注释>

            

多行注释:

             /*多行注释1

            多行注释2

            多行注释3*/

         

代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实现手段(所用算法、循环条件、不同分支的意义等等)。

           

         

二、异常处理

1、数据层服务层异常必须要记录到服务日志中

try

{ }

catch (DbEntityValidationException ex)

{ throw new SerivceException ("");}

catch (SerivceException ex)

{throw ex; }

catch (Exception ex)

{throw new SerivceException (""); }

2、业务层客户端异常要记录在文件中

原则异常msg描述清楚所发生错误原因、关键必要的参数,已便于客户端使用者、测试人员及相关研发人员明白错误原由。

三、Web页面

1、出现超出半屏幕的html标签时需要加注释 例:<!-- BEGIN 描述 --> <body></body> <!-- End 描述 -->

         

2、Js命名规则

函数: fn 例: fnMethod

事件: on例: eventBeforeSave

3、单行的 IF - ELSE,WHILE 或者 FOR 语句也 必须 加入括号,不过他们可以这样写:

if (condition){ statement; }

while (condition){ statement; }

for (intialization; condition; update){ statement; }

4、

foreach(var item in list){

foreach(var item1 in list){

foreach(var item2 in list){

            }

    }

}

         

三、命名规范

 1、程序集命名、命名空间、类(全部为中文名)

1)程序集:项目域名+项目名称+模块名 例:六月版.供应商.业务层

2)命名空间:六月版.供应商.业务层.单据管理 (业务逻辑后缀'管理')

3)类名:订单

2、方法命名

1)业务层、服务方法命名

以混合命名法为主,常用动词单词+中文词描述+'_'+精确描述

        Get***        //'获取***'

        Create***    //'创建***'

        Update***   //'更新***'

        Del***        //'删除***'

        Save***      //'创建或修改***'

        Fill***         //'填充***'  多用于业务逻辑处理

            Add***         //'添加***' 多用于业务逻辑处理

            Remove***   //'移除***' 多用于业务逻辑处理 

        例:public VM.订单 Get订单信息(get='_blank'>string 订单编号)

            public void Update订单状态_已出库(string 订单编号, string 操作人)

             对于获取多条记录的方法名要加以 '集'结尾

            例:public List<VM.订单> Get订单信息(string 关键字)

  1. Mvc Controllers 方法命名(全英文) 开头大写,文件名开头大写

    3)     方法参数全部为中文名,Mvc Controllers方法参数(全英文)//开头字母小写

4)        MVC 分布视图 _开头加开头大写单词

3、变量命名

命名空间引用缩写

业务层: 例:using BS供应商=六月版.供应商.业务层 ;

数据层: 例:using DAO供应商=六月版.供应商.数据层 ;

服务层: 例:using Server供应商=六月版.供应商.服务 ;

视图模型: 例:using VM供应商=六月版.供应商. 视图模型

公共类库: 例:using Comm=DotNet.Common;

变量命名以混合命名法为主

Sbyte: sbte

Char: chr

Short: sht

Object: obj

Int: int

String: str

Long: lng

DateTime: dte

Byte: bte

IntPtr: intptr

Ushot: usht

临时变量: tmp

Uint: uint

Guid: g

Ulong: ulng

(s、dao)实体模型: model    

Float: flt

类的私有变量: m

Double: dbl

静态变量: st

Decimal: dcl

常量: const

Bool: is

全局: p

StringBulider: sb

List:lst

Array: arr

枚举: e

数组: a

对象来自视图:vm

 DbContext:db

     


原标题:代 码 设 计 规 范

关键词:

*特别声明:以上内容来自于网络收集,著作权属原作者所有,如有侵权,请联系我们: admin#shaoqun.com (#换成@)。

可能感兴趣文章

我的浏览记录