没有合适的资源?快使用搜索试试~ 我知道了~
公司C#代码开发规范,详细规范了标识符命名规范,注释规范,排版规范,常用标识符,代码缩写等。对于指导团队开发,代码走查提供帮助。
资源推荐
资源详情
资源评论
软件开发代码规范
V1.7
2016 年 9 月
软件开发代码规范
目 录
一、 标识符命名规范 3
1.1. 缩写......................................................................................................................................3
1.2. 名字空间..............................................................................................................................4
1.3. 宏命名..................................................................................................................................4
1.4. 泛型......................................................................................................................................4
1.5. 枚举......................................................................................................................................4
1.6. 类及其成员..........................................................................................................................5
二、 注释规范 8
2.1. 文件注释..............................................................................................................................8
2.2. 代码注释..............................................................................................................................9
三、 排版规范 9
3.1. 缩进....................................................................................................................................10
3.2. 空格....................................................................................................................................10
3.3. 换行....................................................................................................................................11
3.4. 段落....................................................................................................................................11
四、 常用标识符 12
版 本 历 史
参 考 文 献
《Framework Design Guidelines .Net 设计规范》 2006 年 7
月.Krzysztof Cwalina、Brad Abrams.葛子昂 译.人民邮电出版社
共 12 页 第 2 页
一、 标识符命名规范
标识符是除计算机语言的关键词(keyword)之外,由程序员定
义的字符序列。标识符的命名要尽量简洁而有意义,要用完整的单
词或被广泛认可的缩写。
要设计出自说明(self-documenting)的标识符。
要尽力使标识符的意义清晰和表达一致,而不要追求最短。
要设计出符合应用场景或者业务范畴的标识符。
不要依赖大小写区分标识符。
1.1. 缩写
不要在标识符的命名中使用首字母缩写,除非它普遍被认可。
例如:HTML、XML、FTP、HTTP、RGB、EOF、UI 和 IO。
要把两个字母的首字母缩写全部大写,除非它是小驼峰风格的第
一个单词。
例如:System.IO、StartIO、_snIndex。
三个及其以上的首字母缩写,则要按照驼峰风格。
例如:XmlWriter、LoadHttp、ParseHtmlFormat、GetArgbValue。
不要使用单词缩写,除非一些普遍被认可的缩写(它们通常是按
照,较短的单词去掉“元音”形成缩写;较长的单词可取单词的头几
共 12 页 第 3 页
剩余11页未读,继续阅读
资源评论
codedajie
- 粉丝: 1
- 资源: 22
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功