思考:如何写出让同事难以维护的代码?(1)

简介: 思考:如何写出让同事难以维护的代码?(1)

image.png

本文从【程序命名&注释】【数据类型&类&对象】【控制执行流程】和【程序/结构设计】四个方面梳理了一些真实案例,相信通过这些案例你能迅速get技能:如何写出让同事难以维护的代码doge。


摘要概览

比起什么程序员删库跑路,我更喜欢「写出让同事难以维护的代码」,因为即使不能「名垂千古」,至少VCS可以帮你「遗臭万年」。

‍本文从【程序命名&注释】【数据类型&类&对象】【控制执行流程】和【程序/结构设计】四个方面梳理了一些真实案例,相信通过这些案例你能迅速get技能:如何写出让同事难以维护的代码doge。

说回正题,前几天在家附近的一个小学校旁边散步,突然听到某个学生说“上学期我是‘三好学生’,xxxx”。想了想,学生有“三好”,那么程序员“三好”是什么?

我认为程序员的“三好”是「好用」,「好看」,「好改」。这个是说程序员的代码:

  • 要正确且健壮,就是好用;
  • 要可读性高,易于理解,就是好看;
  • 要方便扩展和改动,就是好改;


平时不少文章都在聊“三好”的正例,今天理一些「好看」的反例,希望给读者一些启发和印象,避免编码中的一些问题,争取做个“三好程序员”吧。


一、程序命名&注释

1.1教你如何挑战维护者

容易输入的变量名

比如:Fred,asdf单字母的变量名。

比如:a,b,c,x,y,z(如果不够用,可以考虑 a1,a2,a3,a4,….)


有创意地拼写错误


比如:SetPintleOpening, SetPintalClosing,这样可以让人很难搜索代码。

image.png


使用缩写和拼音

比如:WTF,RTFSC …… (使用拼音缩写也同样给力,比如:BT,TMD,TJJTDS)

论注释的重要性:不然我以为是「驾校」是一类重要客户,要有单独的helper

image.png


1.2嵌入式文档之殇=注释

不要盲目修改,注意理解!!!

注意理解,你会发现其中的不同点……

image.png

「注意理解」之后,意外出现了……

image.png

程序回忆录


long~ long ago~【狼,狼,啊狗】🐶

image.png

千万注意something


实在不知道注意什么……

image.png

用注释保留一些秘密

image.png


目录
相关文章
|
6月前
|
设计模式 算法 程序员
程序员为何需要反复修改Bug?探寻代码编写中的挑战与现实
作为开发者,我们在日常开发过程中,往往会遇到反复修改bug的情况,而且不能一次性把代码写的完美无瑕,其实开发项目是一项复杂而富有挑战性的任务,即使经验丰富的程序员也难以在一次性编写完美无瑕地完成代码,我个人觉得一次性写好代码是不可能完成的事情。虽然在设计之初已经尽力思考全面,并在实际操作中力求精确,但程序员仍然需要花费大量时间和精力来调试和修复Bug。那么本文就来分享程序员需要反复修改Bug的原因,以及在开发中所面临的复杂性与挑战。
172 1
程序员为何需要反复修改Bug?探寻代码编写中的挑战与现实
|
3月前
|
XML 算法 Java
如何写出让同事无法维护的代码
如何写出让同事无法维护的代码
思考:如何写出让同事难以维护的代码?(2)
思考:如何写出让同事难以维护的代码?
57 0
思考:如何写出让同事难以维护的代码?(2)
思考:如何写出让同事难以维护的代码?(3)
思考:如何写出让同事难以维护的代码?
51 0
思考:如何写出让同事难以维护的代码?(3)
|
API 计算机视觉
思考:如何写出让同事难以维护的代码?(4)
思考:如何写出让同事难以维护的代码?
71 0
思考:如何写出让同事难以维护的代码?(4)
|
程序员 API 计算机视觉
思考:如何写出让同事难以维护的代码?doge
本文从【程序命名&注释】【数据类型&类&对象】【控制执行流程】和【程序/结构设计】四个方面梳理了一些真实案例,相信通过这些案例你能迅速get技能:如何写出让同事难以维护的代码doge。
|
缓存 JavaScript 小程序
接手前同事代码,特别烂,各种BUG,看麻了。。。
接手前同事代码,特别烂,各种BUG,看麻了。。。
|
Java C语言
看似无害的代码如何搞垮系统
编程就像魔法。最近遇到一个诡异的问题:添加一段看似无害的简单代码后,系统原有功能不可用了。 ## 复现演示 jdk 8 可使用如下演示代码复现这个问题。 `TaskCenter` 是一个任务框架,可添加多个任务,随后框架将执行这些任务。 `First` 任务是新增代码,看起来简单无害,且看不出对原有任务 `Count` 有何影响,但添加 `First` 任务后,其自身执行正常,原本正常的 `C
127 0
|
前端开发 JavaScript 测试技术
为了降低维护成本(早点下班),我在组件开发中所做的那些优化(偷懒)
组件开发中为了稳定性、健壮性,经常需要为组件编写测试用例,然后还要为了开发者方便使用编写文档,都是非常耗时间的差事。作为一个独立维护组件库的程序员,为了能够降低组件维护的成本(早点下班),我总结了一下自己过去几年为了让组件开发更加高效所做的那些事情(偷的那些懒)。
|
JSON Java 测试技术
如何写出让人抓狂的代码?
如何写出让人抓狂的代码?
如何写出让人抓狂的代码?

相关实验场景

更多