虽然这是一个类似于api形式的项目,每个api里面只有固定的get,post,之类的才能成为方法。如果我在这个现有的风格上做一些修改,应用一些诸如《代码大全》中定义的“最合适7”的规则,或者一个函数的篇幅最好是一个屏幕那么高的规则,那么会在现有的代码中显得格格不入。我还是把自己的心得记录下来,作为自己的一种追求和努力的方向吧!如果以后有机会,还是需要在一个能够提升代码风格的项目组锻炼下。
- 一个函数本应该只完成一个功能。
现在的系统中,很多地方做一些必要的参数合法性校验,也一股脑写到了函数体中。这导致可能需要阅读几十行代码才能真正进入到核心功能部分的代码。 - 写了setters,getters的类,却堂而皇之地将变量写成了类变量,而且丝毫没有用到private,protect。那在类外可以随便直接调用这些类变量,还用setters和getters作甚?
- 分层混乱。下层操作和上层操作经常混在一起。例如,明明可以实例化类的时候,传入一个构造函数的参数,就可以完成一些初始化操作,却用了一个函数成员去专门进行了类操作。然后在定义了对象之后,先调用初始化操作的函数成员,然后再调用真正需要的操作。
- 类方法和普通的方法并没有加以区分。一个类里面,有的方法在外部不需要访问,只在类的内部进行访问,却也被写成了成员函数。
- 函数的命名不太有解释性。这一点和第一点有交叉的地方。如果一个函数将很多毫无联系的操作揉在一个函数里,那么这也仅仅只是一种毫无意义的强硬做法。就是因为它完成了很多功能,导致在起名字的时候不能有一个很好的答案。既做了大篇幅的合法性校验,又去读取了文件,还实例化了类变量,还对变量进行了修改。那么最终这个函数应该叫什么呢,这真的是一个让人头痛的问题。
- 在python深究中的