好的命名让人少看两遍注释,坏的命名让人多写三段注释。我听完沉默了,因为太真实了。我把这个常量的命名规范统一了一遍,从三种变成一种。从此我多了一条团队规约
😂 IT段子
程序员日常、代码趣事、技术梗图,让你在学习之余轻松一笑
函数名叫 doSomething,看完实现,它确实做了点什么,具体是什么说不清。我忽然觉得,这可能就是这一行的常态。我发现有的工具类叫 Utils,有的叫 Helper,还有叫 Util。同事说这波操作可以写进新人培训教材
命名是一件需要立刻做、又特别容易拖延的事。我停了一下,然后继续手上的活。我发现这个名字和系统保留字冲突,只能加后缀。从此我多了一条团队规约
函数名叫 doSomething,看完实现,它确实做了点什么,具体是什么说不清。我笑了笑,决定不解释。我在心里给这个模块起了个代号,评审时没人听懂。幸好之前留了备份
命名是代码里唯一需要同时考虑机器和人的地方。我抬起头看了看周围,大家都一样。我在心里给这个命名纠结了十分钟,最后用了默认的。复盘会上我们把它列成了案例
我给这个常量起了个解释性的名字,比原来长了一倍。我盯着屏幕沉默了十分钟。我最后用了拼音缩写,然后加了注释解释它是什么意思。这条经验值直接拉满
变量命名二选一:data 和 data2,顶级架构师的纠结就到这了。我发现自己居然没法反驳。我发现这个名字和系统保留字冲突,只能加后缀。办公室安静得能听见键盘声
这个类名和它的实现之间有一层说不清的距离。我打开记录从头到尾扫了一遍。我把命名规范贴在了群里,然后就没人再理我了。真香定律准时生效
新同事问这个类为什么叫 Manager2,我说因为 Manager 被 2018 年的人用过了。我忽然觉得,这可能就是这一行的常态。我把这个类的名字改短了,含义也跟着模糊了。复盘会上我们把它列成了案例
我在命名上纠结了十分钟,最后用了 ctx。我先确认了一遍前置条件,再动手。我把这个模块的命名统一加上了业务前缀,有点冗余。那一刻我觉得自己还是很专业的