代码规范(草案)
来源:互联网 发布:深圳平湖淘宝客服招聘 编辑:程序博客网 时间:2024/04/30 12:20
团队内统一通用命名,通用命名需要慢慢累积, 这个累积成果我把它叫做代码规范,代码规范可以带领提升程序猿的coding本领.
在不同团队中面向的领域是非常不一样的,但是相同领域中应该统一一种命名,我把它叫做专业领域命名。它也需要慢慢累积,也属于代码规范。但是它的适用性并没有通用命名那么强。
代码规范= 通用命名 + 专业领域命名
通用命名其实也是一种专业领域命名,如果让我再给它取个名字,我会以“软件领域命名”命名之。
为什么叫通用命名呢?因为对于程序猿,软件领域就是我们存在的基石。
通用二字由此而来。
好了,不瞎吹逼了。言归正传,刚才说过软件领域命名法是我们的最爱。因此在我们现在的C端,我定一些规矩,为的是让我们以后不需要为定义这些事情发愁。想到某个概念,直接用某个命名即可!
软件领域参考表:
我们汽车超人C端涉及到的领域命名参考表:
命名 表达的概念
CarXxx
OrderXxx
命名原则:
1.别暴露实现
1.命名有意义,根据这个对象的功能来命名.
2.
方法命名原则:
1.方法名应该诠释内部实现的功能,但是不关注它的细节
2.方法做的事情尽量简洁单一。
原则2: 命名要符合人类语法,即用名词来命名“概念”(类名、变量名、局部变量名),用动词短语来命名“行为”(方法、函数)
原则3:
避免使用魔术数字
避免误导
避免使用无意义的字母(如a、b、i…)
使用团队内一致认可的,通用的命名(如:generateXxx生成xxx、searchXxx搜索xxx、doSomethingWithXxx使用xxx做什么操作…)
避免使用编码(避免使用变量前缀、后缀)
类名应该用名词或者名词短语、避免使用动词
方法名应当使用动词或动词短语命名
每个抽象概念选一个词,并一以贯之(团队里面的代码中不应该出现表示同一个抽象概念的不同命名,例如同样表示获取这个抽象概念就不应该在代码里面出现同样表达”获取”这个抽象概念的多个命名fetch、retrieve、get、obtain等等)
多使用解决方案领域命名(例子待完善)
分离解决方案领域跟问题领域的名称命名(遇到与所涉及问题领域更贴近的代码时,应当用问题领域的名称来命名)
- 代码规范(草案)
- php代码规范草案(phpchina)
- PHP代码规范草案0.0.1版
- 软件行业规范(草案)
- Scoped CSS规范草案
- Java Servlet 3.0 规范草案
- HLS-M3U8相关规范(草案)
- HLS-M3U8相关规范(草案)
- 软件行业规范 (草案)v0.2
- Facebook 推出PHP 语言规范草案
- HLS草案(中文版)
- 代码规范(CS)
- 代码规范(二)
- 代码规范(一)
- 中华人民共和国劳动合同法(草案)
- 可编程管线分析(草案)
- 转载: BitTorrent Trackerless DHT协议规范V1.0试行草案
- BitTorrent Trackerless DHT协议规范V1.0试行草案
- HData——ETL 数据导入/导出工具
- window下设置多个用户远程连接
- 文件的复制
- BindingException: Invalid bound statement (not found) 错误解决办法
- 【Unity&Shader】遮罩效果黑暗
- 代码规范(草案)
- bzoj 1874: [BeiJing2009 WinterCamp]取石子游戏 Nim游戏+SG函数
- 【BZOJ4521】手机号码,数位dp
- Storm1.0新版本特性
- CDH集群中YARN的参数配置
- WebStorm12配置react-native运行命令
- 几个机器学习算法及应用领域相关的中国大牛
- set集合和list集合的区别
- solr从pdf、office文档中建立索引