接口设计评审会上,我为一个字段该叫 name 还是 title 争了二十分钟。我拉了个小群,把相关同学都叫了进来。我发现这个名字里有三个错别字,全项目都在用。复盘会上我们把它列成了案例
😂 IT段子
程序员日常、代码趣事、技术梗图,让你在学习之余轻松一笑
命名里最忌讳的是缩写,尤其是自己发明的缩写。我想反驳,但发现他说得对。我把这个类的名字加了 Impl 后缀,其实只有一个实现。感动,然后我学到了新的一课
我在命名上纠结了十分钟,最后用了 ctx。我决定先把手上的事情做完再处理这件事。我把这个方法的参数顺序调整了,命名也跟着变了。这大概就是程序员的人生吧
函数名叫 doSomething,看完实现,它确实做了点什么,具体是什么说不清。我不知道该说什么,就笑了笑。我发现这个名字和系统保留字冲突,只能加后缀。第二天这个方案就变成了团队标准做法
这个名字在三个月后被我自己误解了。我在心里点了点头。我发现有的工具类叫 Utils,有的叫 Helper,还有叫 Util。世界瞬间清净了
接口设计评审会上,我为一个字段该叫 name 还是 title 争了二十分钟。我在心里把涉及的所有环节都过了一遍。我召集了两同事开了一个十五分钟的命名讨论会。感动,然后我学到了新的一课
我给这个接口起名时考虑了三方:上游、下游和未来的我。我先确认了一遍前置条件,再动手。我在心里给这个字段想了个业务上的名字,产品看不懂。那一刻我觉得自己还是很专业的
这个字段叫 data,而项目里有六十个叫 data 的字段。我停了一下,然后继续手上的活。我把这个业务实体的名字对齐了产品文档的叫法。第二天这个方案就变成了团队标准做法
我给这个常量起了个解释性的名字,比原来长了一倍。我把整条链路在心里复盘了一遍。我把这个函数的命名从 save 改成了 persist,回调全改了。同事说这波操作可以写进新人培训教材
命名是代码里唯一需要同时考虑机器和人的地方。我停了一下,然后继续手上的活。我把词典翻了个遍,找到了一个自认为很优雅的词。第二天这个方案就变成了团队标准做法