自我规范(更新中……)
来源:互联网 发布:windows系统iso下载 编辑:程序博客网 时间:2024/05/21 08:54
前言
无规矩不成方圆,这就是说做事要有一定的规矩,写程序也是一样的,要有一定的规范来约束自己,1可以使自己的代码更易读,2写程序时也可以让自己有个指引,不至于看上去杂乱无章。
这是我自己的一套规范,用来约束自己的代码,这样也可以使自己养成一个良好的习惯,提高编码效率。本文规范纯属自己个人见解。
先做设计,写代码先写注释!
如果可以仅从名字就可以知道这个方法是干什么的,一定要这么去做,可以不用注释!
命名规则的前提应该是见名知意。一切的规则都是建立在此基础之上的!
方法统一使用驼峰命名:toLogin()
变量统一使用下划线分割的方法user_name
css类名使用-分割,.error-msg{}
一段代码只要在两处及其以上被使用就提取成方法。
常量不要出现两次,如果出现两次就要定义成变量。
java中方法应该避免写返回值为void的方法,如果无返回值可以返回自己本身,这样就可以像jQuery的级联一样,继续干其他事情。$('#id').css({}).show();
面向对象设计原则(http://www.csdn.net/article/2012-03-14/313089)
原则1:DRY(Don't repeat yourself)
即不要写重复的代码,而是用“abstraction”类来抽象公有的东西。如果你需要多次用到一个硬编码值,那么可以设为公共常量;如果你要在两个以上的地方使用一个代码块,那么可以将它设为一个独立的方法。SOLID设计原则的优点是易于维护,但要注意,不要滥用,duplicate 不是针对代码,而是针对功能。这意味着,即使用公共代码来验证OrderID和SSN,二者也不会是相同的。使用公共代码来实现两个不同的功能,其实就是近似地把这两个功能永远捆绑到了一起,如果OrderID改变了其格式,SSN验证代码也会中断。因此要慎用这种组合,不要随意捆绑类似但不相关的功能。
原则2:封装变化
在软件领域中唯一不变的就是“Change”,因此封装你认为或猜测未来将发生变化的代码。OOPS设计模式的优点在于易于测试和维护封装的代码。如果你使用Java编码,可以默认私有化变量和方法,并逐步增加访问权限,比如从private到protected和not public。有几种Java设计模式也使用封装,比如Factory设计模式是封装“对象创建”,其灵活性使得之后引进新代码不会对现有的代码造成影响。
原则3:开闭原则
即对扩展开放,对修改关闭。这是另一种非常棒的设计原则,可以防止其他人更改已经测试好的代码。理论上,可以在不修改原有的模块的基础上,扩展功能。这也是开闭原则的宗旨。
原则4:单一职责原则
类被修改的几率很大,因此应该专注于单一的功能。如果你把多个功能放在同一个类中,功能之间就形成了关联,改变其中一个功能,有可能中止另一个功能,这时就需要新一轮的测试来避免可能出现的问题。
原则5:依赖注入或倒置原则
这个设计原则的亮点在于任何被DI框架注入的类很容易用mock对象进行测试和维护,因为对象创建代码集中在框架中,客户端代码也不混乱。有很多方式可以实现依赖倒置,比如像AspectJ等的AOP(Aspect Oriented programming)框架使用的字节码技术,或Spring框架使用的代理等。
原则6:优先利用组合而非继承
如果可能的话,优先利用组合而不是继承。一些人可能会质疑,但我发现,组合比继承灵活得多。组合允许在运行期间通过设置类的属性来改变类的行为,也可以通过使用接口来组合一个类,它提供了更高的灵活性,并可以随时实现。《Effective Java》也推荐此原则。
原则7:里氏代换原则(LSP)
根据该原则,子类必须能够替换掉它们的基类,也就是说使用基类的方法或函数能够顺利地引用子类对象。LSP原则与单一职责原则和接口分离原则密切相关,如果一个类比子类具备更多功能,很有可能某些功能会失效,这就违反了LSP原则。为了遵循该设计原则,派生类或子类必须增强功能。
原则8:接口分离原则
采用多个与特定客户类有关的接口比采用一个通用的涵盖多个业务方法的接口要好。设计接口很棘手,因为一旦释放接口,你就无法在不中断执行的情况下改变它。在Java中,该原则的另一个优势在于,在任何类使用接口之前,接口不利于实现所有的方法,所以单一的功能意味着更少的实现方法。
原则9:针对接口编程,而不是针对实现编程
该原则可以使代码更加灵活,以便可以在任何接口实现中使用。因此,在Java中最好使用变量接口类型、方法返回类型、方法参数类型等。《Effective Java》 和《head first design pattern》书中也有提到。
原则10:委托原则
该原则最典型的例子是Java中的equals() 和 hashCode() 方法。为了平等地比较两个对象,我们用类本身而不是客户端类来做比较。这个设计原则的好处是没有重复的代码,而且很容易对其进行修改。
- 自我规范(更新中……)
- 前段规范(更新中)
- 自我命名规范
- 自我学习,自我激励……
- java编程规范(继续更新中......)
- 我的编程规范【持续更新中】
- 移动app 自我更新
- sqlserver 自我关联 更新问题
- java自我总结--待更新
- 【Android 应用开发】 Android 相关代码规范 更新中 ...
- iOS开发编码建议与规范(持续更新中)
- Android开发实战总结--编程规范(持续更新中...)
- 更新器自动更新自己(自我更新)
- 学习是自我规范的过程
- 20170304 SQL server 自我弥补代码规范
- 迷茫中寻找自我
- 迷茫中寻找自我
- 迷茫中寻找自我
- Java中equals和==的区别
- 上传带图片的Http请求
- CENTOS6.3环境下安装VSFTPD
- mysql截取字符串
- android 解析json数据格式
- 自我规范(更新中……)
- commons-email 轻松发送无乱码邮件
- Java程序员应该了解的10个面向对象设计原则
- 从SNAT/DNAT角度分析数据包流转
- monkeyrunner1
- apache部署多个项目
- 基于Proteus+8051汇编应用实例系列之一--单只数码管循环显示数字
- linux shell 之xargs 的简单使用
- Sublime Text 2 小记