就我看来,好的接口设计有两道关卡:
第一道是接口的命名。如果接口的命名直接就能看出接口的作用,那么可以打分“优”。
第二道关卡是返回值。如果接口的命名看不出来,那么直接进入接口的内部,看看最后一句返回值,如果结合返回值和接口能看出接口作用的,可以打分"良"。当然,这里还有个没有返回值的接口的情况,没有返回值的这种接口,接口内部的代码要命名清晰,同时代码精简,行数不要超过10行,最好不要超过5行。
如果这两道关卡都突破了,那么就需要注释帮忙了,如果结合注释能看明白,还能给个“及格”。如果连注释都帮不上忙,甚至没注释,那么这个接口一定不及格。