函数和变量命名

这几天在检查公司oa系统与企业微信同步的代码,发现一些命名做得不好,并不能让人一眼就能看懂该函数、变量到底是要做什么。

比如有个从oa系统同步部门到企业微信,函数命名为:handleDept

从企业微信同步部门到oa系统,函数命名为:handleWxdept

这两个名字看起来并不清晰,不能让人一眼看明白。

修改方案为 handleDept => syncDeptToWx

修改方案为 handleDept => syncDeptToOa

忘了在哪看过,说最好的注释就是没有注释,其他人可以通过你的函数、变量命名,看懂你的代码,这样就不需要读注释了。

posted @ 2018-05-31 15:42  ohmydenzi  阅读(302)  评论(0编辑  收藏  举报