思考:如何写出让同事难以维护的代码?(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


目录
相关文章
|
8月前
|
设计模式 算法 程序员
程序员为何需要反复修改Bug?探寻代码编写中的挑战与现实
作为开发者,我们在日常开发过程中,往往会遇到反复修改bug的情况,而且不能一次性把代码写的完美无瑕,其实开发项目是一项复杂而富有挑战性的任务,即使经验丰富的程序员也难以在一次性编写完美无瑕地完成代码,我个人觉得一次性写好代码是不可能完成的事情。虽然在设计之初已经尽力思考全面,并在实际操作中力求精确,但程序员仍然需要花费大量时间和精力来调试和修复Bug。那么本文就来分享程序员需要反复修改Bug的原因,以及在开发中所面临的复杂性与挑战。
204 1
程序员为何需要反复修改Bug?探寻代码编写中的挑战与现实
|
5月前
|
XML 算法 Java
如何写出让同事无法维护的代码
如何写出让同事无法维护的代码
思考:如何写出让同事难以维护的代码?(2)
思考:如何写出让同事难以维护的代码?
67 0
思考:如何写出让同事难以维护的代码?(2)
|
API 计算机视觉
思考:如何写出让同事难以维护的代码?(4)
思考:如何写出让同事难以维护的代码?
89 0
思考:如何写出让同事难以维护的代码?(4)
思考:如何写出让同事难以维护的代码?(3)
思考:如何写出让同事难以维护的代码?
60 0
思考:如何写出让同事难以维护的代码?(3)
|
消息中间件 算法 安全
开发者最怕遇到的代码报错
作为一名开发者,遇到代码报错是再平常不过的事情了。无论是在编写新代码还是修改现有代码时,都有可能出现各种各样的错误。有些错误可能只是简单的语法错误,而有些错误可能会导致整个程序无法正常运行。另外,结合阅读《实战总结|记一次消息队列堆积的问题排查》这篇文章,作者在工作中遇到的消息队列堆积的问题以及如何解决这一问题的过程,我深刻认识到了在开发过程中遇到问题准确排查的重要性,以及解决问题的策略和方法。那么接下来,就来聊一聊开发者最怕遇到的代码报错,以及如何有效地解决和避免这些问题。
303 2
开发者最怕遇到的代码报错
|
缓存 Java 测试技术
痛击面试官!CURD系统也能做出技术含量
很多朋友可能会因为自己做的工作不是特别核心或者业务简单而引起面试中没有自信。但是很多公司面试的时候是可以接受面试者之前岗位的并发量、交易量低一些的。比如我们要招聘和我们交易量同等级或者以上的出来的人才,业界本来就没有多少,但我们还是要招人的。所以很多时候更偏向于考察面试者的设计底蕴、思考和解决问题的能力。
|
程序员 API 计算机视觉
思考:如何写出让同事难以维护的代码?doge
本文从【程序命名&注释】【数据类型&类&对象】【控制执行流程】和【程序/结构设计】四个方面梳理了一些真实案例,相信通过这些案例你能迅速get技能:如何写出让同事难以维护的代码doge。
|
缓存 JavaScript 小程序
接手前同事代码,特别烂,各种BUG,看麻了。。。
接手前同事代码,特别烂,各种BUG,看麻了。。。
|
消息中间件 JavaScript 小程序
用1个月重构了同事写的烂代码,我总结出了15条重写烂代码的经验!
用1个月重构了同事写的烂代码,我总结出了15条重写烂代码的经验!