优秀的接口的评价标准

      就我看来,好的接口设计有两道关卡:

      第一道是接口的命名。如果接口的命名直接就能看出接口的作用,那么可以打分“优”。

      第二道关卡是返回值。如果接口的命名看不出来,那么直接进入接口的内部,看看最后一句返回值,如果结合返回值和接口能看出接口作用的,可以打分"良"。当然,这里还有个没有返回值的接口的情况,没有返回值的这种接口,接口内部的代码要命名清晰,同时代码精简,行数不要超过10行,最好不要超过5行。

     如果这两道关卡都突破了,那么就需要注释帮忙了,如果结合注释能看明白,还能给个“及格”。如果连注释都帮不上忙,甚至没注释,那么这个接口一定不及格。 

转载于:https://www.cnblogs.com/cly84920/archive/2012/04/13/4426529.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值