好的命名让人少看两遍注释,坏的命名让人多写三段注释。我发现自己居然没法反驳。我发现这个名字里有数字,是从别的项目复制过来的。世界瞬间清净了
😂 IT段子
程序员日常、代码趣事、技术梗图,让你在学习之余轻松一笑
这个字段叫 data,而项目里有六十个叫 data 的字段。我停了一下,然后继续手上的活。我把这个测试方法的命名写成了完整一句话,非常长。办公室安静得能听见键盘声
我给这个变量想了个准确的名字,它有二十四个字符。我先确认了一遍前置条件,再动手。我把这个方法的命名从 list 改成了 query,因为要分页。第二天这个方案就变成了团队标准做法
这个名字在三个月后被我自己误解了。我想了想自己这些年,好像确实如此。我在心里给这个类想了个更有业务含义的名字,太长了。我沉默了,但心里是服的
命名最怕的是把未来的实现细节写进名字里。我笑了笑,决定不解释。我在心里给这个临时变量起了个正经名字,它存活了三分钟。真香定律准时生效
我给这个变量想了个准确的名字,它有二十四个字符。我把手上的资料翻出来又读了两遍。我在心里给这个类想了个更有业务含义的名字,太长了。我沉默了,但心里是服的
我把这个模块的名字从中文拼音换成了英文,团队里两种都有。我把这个类的名字加了 Impl 后缀,其实只有一个实现。感动,然后我学到了新的一课
我给这个变量想了个准确的名字,它有二十四个字符。我发现这个名字的拼写是错的,但已经上线不敢改。我沉默了,但心里是服的
我把这个模块的名字从中文拼音换成了英文,团队里两种都有。我把整条链路在心里复盘了一遍。我发现有的工具类叫 Utils,有的叫 Helper,还有叫 Util。从此我多了一条团队规约
这个类名和它的实现之间有一层说不清的距离。我盯着屏幕沉默了十分钟。我把这个函数的命名从动词改成了名词,调用方全懵了。复盘会上我们把它列成了案例