1

最近比较忙,总结了一下,从书上和实际工程中学习到的一些小技巧,或者说是习惯

1 命名规范

命名最好遵循驼峰法和下划线法,并且要清楚的表达变量的意思。

相对于驼峰法而言,我更喜欢下划线法。下划线法可以更清楚的看出这个变量表示的意思。比如aBigGreenBanana和一个a_big_green_banana。

还有一个从nginx中学到的命名习惯,我觉得也挺好的。比如http_run,system_run,通过前置或者后置的一个单词可以清楚的表示这时system还是http模块中的函数。又比如可以利用在前端中

article_reset_button,article_submit_button,
image_reset_button,image_submit_button

这样的命名会让代码可读性更好。

2 代码重用和简化

代码重用就是抽象出共有的代码,便于其他函数调用。

但是有时候可能代码只用1次,但是为了易读性,扩展性和维护性,我认为是可以抽象出来,写成一个函数
例如

    class A{
        public void A(){
            A部分
            B部分
            C部分
        }
    }
    
    class A{
        public void A(){
            A_a();
            A_b();
            A_c();
        }
        private function A_a(){}
        private function A_b(){}
        private function A_c(){}
    }

这样子代码会更加清楚,而且根据一个经验法则,代码最好控制在40-60行之内吧(Unix编程艺术)这样bug会更少。

3 保持一致

与以前的代码的风格,命名保持一致。

第一个好处是代码重用。例如 以时间为依据,文件目录为article/2018/03/28/img/ 。同一个项目下有一个相同的 new/2018-03-28/03-28/28/img。这个就是给自己增加工作量。明明可以写一个可重用代码。

第二个好处是可以避免一些历史问题。刚接手一个项目,不要急着否定。有些代码看上去很奇怪,可以用更好的方式去处理。但是实际上可能这一段代码是为了处理某些特殊的情况。我曾经有过这样经历,认为这是SB,但是读完我完整的代码之后,我认为我自己就是SB。

第三个好处是提高代码的可读性。比如hadoop文件系统的命令,其实就是继承了Linux 系统的命令。这样别人上手就会很快。

4 结构完整

mvc并不仅仅是mvc

实际项目中并不仅仅是mvc,有的时候有关于字符串的处理类,关于定时任务的处理类等等其他的类,将这些类做一个归档,而不是随手写在某一个类中。


fish
101 声望2 粉丝

希望你能够学习新的技术