代码开发规范.pdfVIP

C#代代码码开开发发规规范范

文件状态：文件标识：

[√]草稿当前版本：1.1

[]正式作者：mpty

[]修改联系电话：

最后更新：2014-04-07

版版本本记记录录

日日期期版版本本号号作作者者说说明明

2014-4-21.0Empty创建

2014-4-71.1Empty添加前言、注规范与编码规范

目目录录

1.前言4

1.1编写目的4

1.2适用范围4

1.3基本要求4

2.命名规范4

2.1字母大小写约定4

2.1.1说明4

2.1.2Pascal风格4

2.1.3Camel风格5

2.2标识符的大小写规5

2.3通用命名约定5

2.3.1选择名称5

2.3.2字母缩写词6

2.4命名空间命名6

2.5类、结构和接口命名6

2.6逻辑层类命名6

2.7文件夹命名7

3.注释规范7

3.1模块（类）注释规范7

3.2类属性注释规范7

3.3方法注释规范7

3.4代码间注释规范8

4.编码规范9

1.前前言言

11..11编编写写目目的的

为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。

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

1)一个软件的生命周期中，80%的花费在维护。

2)几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。

3)编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。

每个软件开发人员都必须遵守统一的编码规范。

11..22适适用用范范围围

本规范适用《从零开始编写自己的C#框架》的开发。

11..33基基本本要要求求

尽量使代码简单直白。

2.命命名名规规范范

22..11字字母母大大小小写写约约定定

2.1.1说说明明

表达清晰的命名规范是程序规划的核心，如果规范的命名能清晰的表达出相应的

功能，就可以让人“望文知意”，提高开发效率和系统的可维护性。反之，如果

命名不能表达其含义，例如“aaa”、“bbb()”，那么将适得其反。

2.1.2Pascal风风格格

包含一到多个单词，每一个单词第一个字母大写，其余字母均小写。例如：

HelloWorld、SetName等。

2.1.3Camel风风格格

包含一到多个单词，第一个单词首字母小写，其余单词首字母大写。例如：name、

prductId等。

22..22标标识识符符的的大大小小写写规规则则

1)除了参数与变量外，所有命名空间名称、类、函数、接口、属性等名称的命名，使

用Pascal风格。

2)参数与变量的命名，使用Camel风格。