首页 > 代码库 > 怎样写一个好的方法

怎样写一个好的方法

方法,一个程序的基本组成,程序编写的最小设计单位,但写好一个方法却不容易。

先说什么样的方法才是一个好方法。首先,可读性要好,因为程序在编译运行之前一直都是给人看的;其次,对于耗费资源或者运算量大的方法,效率也很重要。

这里只讨论可读性。对于效率那是程序优化的技术问题,需要一定的功底,但可读性是我们所有人花些心力都可以做的很好的,而且这个做好了,也就很好了。

首先看一个方法有哪些组成部分,以Java为例,包括访问控制关键字,static关键字(对于static方法),返回值,方法名,参数列表,异常列表,方法体。

一些没什么好说的,从方法名开始,方法名一定要准确表达方法所实现的功能,切记,每个方法只实现一个功能,保证单一性原则,方法名要用动宾短语的形式,表示这个方法是做一件事的方法,而不是一个变量名。

参数列表,尽量不要太多,参数名要明确易懂,不要用i,j,k等,多个参数之间的排列要体现出逻辑关系,让调用者可以根据顺序和名称知道一些信息。

方法体,这是一个方法的主体,一般由变量声明、赋值,语句,逻辑控制结构,注释组成。

变量声明要注意将有关系的变量在一块声明,而且每个一行,变量名要起得有意义。

语句之间一定要有清晰的逻辑结构。

控制结构要注意多层嵌套时出现问题,如果嵌套过多可以考虑将里层嵌套抽象成方法,对于控制结构里的条件判断,如果过于复杂,也要抽象出来,赋以有意义的变量或者抽象成方法。

注释要简洁,精炼并且能说明逻辑,对于复杂或者难于理解的算法也可以辅以解释说明,对于过于简单的逻辑和代码不需要注释,注释还可以在较长的逻辑判断之后做结束标记,例如:

if(isNull()){
    ...
} // end of if