昨天团队开回顾会,一起讨论了为什么有的模块上手很慢,其中一个妹子提到了在做a模块的时候通过看代码就能看出业务是什么,而b 模块首先方法名看不出干什么,进入方法中才能大概看出实现了什么,看代码看不出业务是什么。
引发大家的大讨论,有人说应该为代码写注释,有人说方法命名可不是一件容易的事情。
关于写注释,我比较认可的观点:
(1)团队成员A说通过她的经验发现:改了代码,往往开发人员都不会主动的去改注释,注释到最后反而起不到作用
(2)我咨询了国内顶尖的tdd 高手,他的观点也是写注释只能说明你的方法命名不好,别人无法理解你的方法的含义你才去写注释进行说明
关于方法命名:
(1)团队成员B:我研究方法命名一年发现方法命名如果想要命名好,那么框架设计和代码架构要合理并且简单,然后方法命名才能命名好,写代码和写文章一样,每一个方法就是一个主题。如果想要把方法命名好,建议读懂cleancode 代码大全 编程珠玑
(2)部门教练: 名不正则言不顺,名字没办法起好,其实已经说明代码本身就存在问题了
亲爱的读者你认为那?在实际的编程实践中,有时写完一个函数的功能,想找不到适合的名字为之命名。其实原因很可能是因为函数的职责不单一,所以很难给它取一个好的名字。通常需要对函数进行拆分,让它保持只做一件事情,名字就随手可得了。