代码规范：规范你我他

àì夳堔傛蜴生んèń 2023-06-27 12:45 11阅读 0赞

# 学习代码规范的目的： #

###        为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护。 ###

###       因为软件是需要人来维护的，这个人在未来很可能不是你。所以首先是为人编写程序，要让大家可以一眼看懂你写的是什么，简洁的代码更容易看出bug，让bug无处躲藏。 ###

# 为什么要规范代码： #

### 第一：统一性，有助于团队的合作 ###

### 第二：减低维护成本 ###

### 第三：简洁，简洁的代码更好凸显出BUG ###

### 第四：养成良好的习惯，帮助自己成长。 ###

# 注释规范： #

### 对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释： ###

/*************************************************
    
    作者：
    
    小组： 
    
    说明：
    
    创建日期：
    
    版本号：
    
    **********************************************/

### 在模块、类、属性、方法前一行添加注释，以便调用的时候提示用户 ###

### 下以方法声明做例子： ###

/// <summary>
    
            /// depiction：<对该方法的说明>
    
            /// </summary>
    
            /// <param name="<参数名称>"><参数说明></param>
    
            /// <returns>
    
            ///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>
    
            /// </returns>

# 命名规则： #

*  ### 名字应该能够标识事物的特性，并且与业务挂钩。 ###
 *  ### 名字一律使用英文单词，而不能为拼音。 ###
 *  ### 名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。 ###
 *  ### 在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。 ###

# ** ****数据库命名规则：** #

###   数据库名采用首字母大写，避免系统保留的表名。如：LibraryMaintainSystem ###