没有合适的资源?快使用搜索试试~ 我知道了~
项目文件组织及代码规范
4星 · 超过85%的资源 需积分: 50 8 下载量 113 浏览量
2015-09-22
16:44:22
上传
评论
收藏 543KB PDF 举报
温馨提示
试读
14页
真的不错,以前变量命名糟糕透了,大小写没规则,中英文混合,前缀后缀混乱,局部全局没差别。看了这个文档好多了。
资源推荐
资源详情
资源评论
项目文件组织及代码开发规范
目 录
项目文件组织及代码开发规范 ................................................................................ 1
1、代码规范的重要性...................................................................................... 2
2、开发代码命名规范介绍 .............................................................................. 2
3、命名总体规则 ............................................................................................. 2
4、项目及文件夹命名规范 .............................................................................. 2
4.1 类命名规范: ..................................................................................... 2
4.2 类、方法所属字段(变量)命名规范 ............................................... 3
4.3 方法规范 ............................................................................................. 4
4.4 属性规范 ............................................................................................. 5
4.5 参数规范 ............................................................................................. 5
4.6 常量规范 ............................................................................................. 5
4.7 接口规范 ............................................................................................. 6
4.8 命名空间规范 ..................................................................................... 6
5、代码编写规范 ............................................................................................. 6
5.1 缩进规则 ............................................................................................. 6
5.2 比较规则 ............................................................................................. 6
5.3 对齐规则 ............................................................................................. 7
5.4 模块化规则 ......................................................................................... 7
5.5 模块设计原则 ..................................................................................... 7
5.6 数据库操作 ......................................................................................... 7
5.7 函数返回值原则 .................................................................................. 8
5.8 注释风格规范 ..................................................................................... 8
5.9 文件规范 ............................................................................................. 8
6、常见语句书写规则...................................................................................... 8
7、常见数据类型缩写表 ................................................................................ 10
8、服务器控件名称缩写表(MVC 基本上不会出现这些控件) ....................... 11
8.1 web 控件名称缩写表 ........................................................................ 11
8.2 html 控件名称缩写表........................................................................ 13
1、代码规范的重要性
1) 规范的代码可以促进团队合作;
2) 规范的代码可以减少 bug 处理,查找 bug 也变得轻而易举;
3) 规范的代码可以降低维护成本;
4) 规范的代码有助于代码审查;
5) 养成代码规范的习惯,有助于程序员自身的成长。
2、开发代码命名规范介绍
1) Pascal 规范:大小写形式-所有单词第一个字母大写,其他字母小写。
2) Camel 规范:大小写形式-除了第一个单词,所有单词第一个字母大写,
其他字母小写。
3、命名总体规则
1) 命名中一律使用英文单词,不能使用汉语拼音。
2) 所有项目、文件夹、代码文件都要有与本身实现功能相对应的名称,要
求清晰明了,无歧义。
3) 名字尽量不使用缩写,除非它是众所周知的。
4) 名字可以有两个或三个单词组成,但不应多于三个,控制在 3 至 30 个字
母以内。
5) 名字尽量使用前缀而不是后缀。
4、项目及文件夹命名规范
1) 项目及存放代码文件的文件夹,使用 Pascal 命名规则命名:首字母大写。
2) 存放资源的文件夹可使用小写,如: css、img、js、dll 等。
4.1 类命名规范:
A. 使用 Pascal 规则命名类名,首字符要大写;
B. 使用能够反映类功能的名词或名词短语命名类;
C. 类文件的名称要能反映类的内容。
4.2 类、方法所属字段(变量)命名规范
A. 使用 camel 规则命名类成员字段;
B. 字段名称= 变量的前缀 +代表变量含意的英文单词或单词缩写;
C. 类变量前缀为:“m_” +数据类型缩写(小写)(其中,m 为“memory”
缩写,数据类型缩写见 7.1 常见数据类型缩写表)。如:
public class Hello
{
private string m_strName;
private DateTime m_dtDate;
}
D. 类的属性所对应的变量,采用属性名前加“m_”+ 类型缩写 前缀的形式。
如: public class Hello
{
private string m_strName;
public string Name
{
get
{
return m_strName;
}
}
}
E. 函数级的变量使用”_”+类型缩写前缀。如:
public class Hello
{
void say()
{
string _strSayWord;
}
}
F. 补充说明:
a) 针对异常捕获过程中的 Exception 变量命名,在没有冲突的情况下,
统一命名为 exp;
剩余13页未读,继续阅读
资源评论
- jmy2122020-02-27还不错,谢谢分享
爱吃糖葫芦
- 粉丝: 0
- 资源: 1
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功