文档和注释
在注释中撒谎
。你不用真的去撒谎,只需在改代码的时候不要更新注释就可以了。
注释明显的东西
。比如:/* add 1 to i */。(参看本站的“五种应该避免的注释
”)
只注释是什么,而不是为什么
。
不要注释秘密
。如果你开发一个航班系统,请你一定要保证每有一个新的航班被加入,就得要修改25个以上的位置的程序。千万别把这个事写在文档中。
注重细节
。当你设计一个很复杂的算法的时候,你一定要把所有的详细细设计都写下来,没有100页不能罢休,段落
要有5级以上,段落编号要有500个以上,例如:1.2.4.6.3.13 – Display all impacts for
activitywhere selected mitigations can apply(short pseudocode omitted).
这样,当你写代码的时候,你就可以让你的代码和文档一致,如:Act1_2_4_6_3_13()
千万不要注释度衡单位
。比如时间用的是秒还是毫秒,尺寸用的是像素还是英寸,大小是MB还是KB。等等。另外,在你的代码里,你可以混用不同的度衡单位,但也不要注释。
Gotchas
。陷阱,千万不要注释代码中的陷阱。
在注释和文档中发泄不满
。(参看“五种应该避免的注释
”)
程序设计
Java Casts
。Java的类型转型是天赐之物。每一次当你从Collection里取到一个object的时候,你都需要把其转回原来的类型。因些,这些转型操作会出现在N多的地方。如果你改变了类型,那么你不一定能改变所有的地方。而编译器可能能检查到,也可能检查不到。
利用Java的冗余
。比如:Bubblegum b = new Bubblegom(); 和 swimmer = swimner + 1; 注意变量间的细微差别。
从不验证
。从不验证输入的数据,从不验证函数的返回值。这样做可以向大家展示你是多么的信任公司的设备和其它程序员。
不要封装
。调用者需要知道被调用的所有的细节。
克隆和拷贝
。为了效率,你要学会使用copy+ paste。你几乎都不用理解别人的代码,你就可以高效地编程了。(陈皓注:Copy+ Paste出来的代码bug多得不能再多)
巨大的listener
。写一个listener,然后让你的所有的button类都使用这个listener,这样你可以在这个listener中整出一大堆if…else…语句,相当的刺激。
使用三维数组
。如果你觉得三维还不足够,你可以试试四维。
混用
。同时使用类的get/set方法和直接访问那个public变量。这样做的好处是可以极大的挫败维护人员。
包装,包装,包装
。把你所有的API都包装上6到8遍,包装深度多达4层以上。然后包装出相似的功能。
没有秘密
。把所有的成员都声明成public的。这样,你以后就很难限制其被人使用,而且这样可以和别的代码造成更多的耦合度,可以让你的代码存活得更久。
排列和阻碍
。把drawRectangle(height,width)改成 drawRectangle(width, height),等release了几个版本后,再把其改回去。这样维护程序的程序员们将不能很快地明白哪一个是对的。
把变量改在名字上
。例如,把setAlignment(int alignment)改成,setLeftAlignment, setRightAlignment, setCenterAlignment。
Packratting
。保留你所有的没有使用的和陈旧的变量,方法和代码。
That’s Fina
l。Final你所有的子结点的类,这样,当你做完这个项目后,没有人可以通过继承来扩展你的类。java.lang.String不也是这样吗?
避免使用接口
。在java中,BS接口,在C++中BS使用虚函数。
避免使用layout
。这样就使得我们只能使用绝对坐标。如果你的老大强制你使用layout,你可以考虑使用GridBagLayout,然后把grid坐标hard code.
环境变量
。如果你的代码需要使用环境变量。(getenv()– C++ / System.getProperty()– Java ),那么,你应该把你的类的成员的初始化使用环境变量,而不是构造函数。
使用Magic numbe
r。参看《Linux一个插曲
》。
使用全局变量
。1)把全局变量的初始化放在不同的函数中,就算这个函数和这个变量没有任何关系,这样能够让我们的维护人员就像做侦探工作一样。2)使用全局变量可以让你的函数的参数变得少一些。
配置文件
。配置文件主要用于一些参数的初始化。在编程中,我们可以让配置文件中的参数名和实际程序中的名字不一样。
膨胀你的类
。让你的类尽可能地拥有各种臃肿和晦涩的方法。比如,你的类只实现一种可能性,但是你要提供所有可能性的方法。不要定义其它的类,把所有的功能都放在一个类中。
使用子类
。面向对象是写出无法维护代码的天赐之物。如果你有一个类有十个成为(变量和方法)你可以考虑写10个层次的继承,然后把这十个属性分别放在这十个层次中。如果可能的话,把这十个类分别放在十个不同的文件中。
混乱你的代码
使用XML
。XML的强大是无人能及的。使用XML你可以把本来只要10行的代码变成100行。而且,还要逼着别人也有XML。(参看,信XML得永生
,信XML得自信
)
混乱C代码
。在《如何加密源代码》中已经说过一些方法了,这里再补充一些。
使用不同的进制
。比如:10 和010不是一样的。再比如:array = new int[]{ 111, 120, 013, 121,};
尽量使用void*
。然后把其转成各种类型
使用隐式的转型
。C++的构造函数可以让你神不知鬼不觉得完成转型。
分解条件表达式
。如:把 a==100分解成,a>99 && a<101
学会利用分号
。如:if ( a );else;{ int d; d = c;}
间接转型
。如:把double转string,写成new Double(d).toString()而不是 Double.toString(d)
大量使用嵌套
。一个NB的程序员可以在一行代码上使用超过10层的小括号(),或是在一个函数里使用超过20层的语句嵌套{},把嵌套的if else 转成 [? :] 也是一件很NB的事。
使用C的变种数组
。myArray[i] 可以变成*(myArray+ i)也可以变成*(i +
myArray)其等价于 i[myArray]。再看一个函数调用的示例,函数声明:int myfunc(int q, int p){
return p%q; }函数调用myfunc(6291, 8)[Array];
长代码行
。一行的代码越长越好。这样别人阅读时就需要来来回回的
不要较早的return
。不要使用goto,不要使用break,这样,你就需要至少5层以上的if-else来处理错误。
不要使用{}
。不要在if else使用{},尤其是在你重量地使用if-else嵌套时,你甚至可以在其中乱缩进代码,这样一来,就算是最有经验的程序员也会踩上陷阱。
使用宏定义
。宏定义绝对是混乱C/C++代码的最佳利器。参看老手是这样教新手编程的
。
琐碎的封装
。比较封装一个bool类,类里面什么都做,就是一个bool.
循环
。千万不可用for(int i=0; i<n; i++)使用while代替for,交换n和i,把<改成<=,使用 i–调整步伐。
测试
从不测试
。千万不要测试任何的出错处理,从来也不检测系统调用的返回值。
永远不做性能测试
。如果不够快就告诉用户换一个更快的机器。如果你一做测试,那么就可能会要改你的算法,甚至重设计,重新架构。
不要写测试案例
。不要做什么代码覆盖率测试,自动化测试。
测试是懦夫行为
。一个勇敢的程序员是根本不需要这一步的。太多的程序太害怕他们的老板,害怕失去工作,害怕用户抱怨,甚至被起诉。这种担心害怕直接影响了生产力。如果你对你的代码有强大的信心,那还要什么测试呢?真正的程序员是不需要测试自己的代码的。
其它
你的老板什么都知道
。无论你的老板有多SB,你都要严格地遵照他的旨意办事,这样一样,你会学到更多的知识如何写出无法维护的代码来的。
颠覆Help Desk
。你要确保你那满是bug的程序永远不要被维护团队知道。当用户打电话和写邮件给你的时候,你就不要理会,就算要理会,让用户重做系统或是告诉用户其帐号有问题,是标准的回答。
闭嘴
。对于一些像y2k这样的大bug,你要学会守口如瓶,不要告诉任何人,包括你的亲人好友以及公司的同事和管理层,
忽悠
。你会学会忽悠,就算你的代码写得很烂,你也要为其挂上GoF设计模式的标签,就算你的项目做得再烂,你也
要为其挂上敏捷的标签,只有学会像中国Thoughtworks的咨询师那样去忽悠,你才能学会更炫更酷的方法,让整个团队和公司,甚至整个业界都开始躁
动,这样才能真正为难维护的代码铺平道路。
这个文档中还有很多很多,实在是太强大了,大家自己去看看吧。有精力有能力的朋友不妨把其翻译成中文。
总之,我们的口号是——Write Everywhere,Read Nowhere
相关推荐
### 如何编写无法维护的代码:深入解析与反思 #### 总体概述 本文通过一种讽刺的方式探讨了如何编写难以维护的代码。虽然标题看似戏谑,但实际上文章旨在揭示那些不利于代码可读性和可维护性的做法。对于软件开发...
如何写出无法维护的代码?酷壳里有很多我觉得很不错的文章,但是访问量最大的却是那篇《6个变态的HelloWorld》,和它能在本站左边栏“全站热门”中出现的还有“如何加密源代码”,以及编程真难啊等这样的文章。可见本...
针对Java程序员,《如何写出更加优雅代码指南》提供了一系列实用建议和最佳实践,帮助开发者提升代码质量,降低后期维护成本。以下是一些关键知识点的详细说明: 1. **注释与文档** - 注释应当简洁明了,解释代码...
在IT行业中,C#是一种广泛使用的编程语言,尤其在开发Windows桌面应用、Web应用以及游戏开发等领域。...掌握这些技术,开发者可以构建出功能强大的系统维护工具,提升工作效率,确保系统的稳定运行。
### 写出高效率代码:VB编程技巧与实践 #### 概述 本文旨在探讨如何通过采用特定的技术手段来提高VB(Visual Basic)代码的执行效率。这些技术手段大致可以归纳为两大类:编码技术和编译优化技术。通过具体实例和...
通过学习和实践这些C程序代码风格的经典原则,你将能够写出更高质量的代码,减少调试时间和后期维护成本,从而提升自己的编程能力。不断学习和总结,你的代码将更加优秀,成为你职业生涯的亮点。
这条规则对编写 Java 代码的基本命名规则进行了规定,帮助开发者写出易读易维护的代码。 规则 2: 在创建一个类时,请采取“经典形式”,并包含对下述元素的定义:equals()、hashCode()、toString()、clone()...
【写出优雅代码(C#)篇】探讨的是如何提高C#编程的可读性和维护性,通过遵循一些最佳实践和技巧,使代码更加简洁且优雅。本文由姜敏分享,涉及了多个论题,旨在促进开发者之间的交流和学习。 **论题一:函数越小越好...
### 每天写出好代码的5个建议 在软件开发领域,编写高质量的代码是每个程序员追求的目标。良好的代码不仅能够提高程序的稳定性和可维护性,还能够提升团队的协作效率。以下是从给定文件中提炼出的五个关于如何每天...
根据给定的文件信息,可以看出文章的主题是关于“每天写出好代码”的建议。然而,提供的部分内容似乎包含了乱码或者是非中文字符,导致无法直接从中提取有意义的信息。因此,本篇文章将依据标题和描述来展开“每天写...
代码是否正确或进行修改就会变得更为轻松。在C#编程中,遵循良好的代码规范对于提升代码质量至关重要。...通过不断学习和实践,开发者可以写出更易于阅读、理解和维护的代码,从而提高整个项目的质量和效率。
本篇文章主要探讨了几个关键的编码实践和原则,帮助开发者写出更优雅的C#代码。 首先,命名规范是编写清晰代码的基础。类名、方法和常量应遵循Pascal casing,如`MyClass`和`MyMethod`;局部变量和参数使用camel ...
标题和描述中的知识点聚焦于如何在单片机上编写出高效且优雅的C语言代码,这一主题对于嵌入式系统开发至关重要。以下是对标题、描述以及部分提供的内容中提到的知识点的详细阐述: ### 代码稳定性与隐患预防 在...
以下就是从"5种方法立刻写出更好的CSS代码"这个主题中提取出的关键知识点: 1. **选择器优化**:有效利用类选择器和ID选择器,避免使用过于具体的元素选择器。减少选择器的复杂度可以提高浏览器解析速度。例如,...
根据提供的文件信息,标题、描述和标签均指向“每天写出好代码的5个建议05”。但是,部分内容似乎并未提供具体的信息或者明确的建议。因此,我们将基于标题和描述给出五个有助于每天写出优质代码的建议。 ### 每天...
"设计模式之美——教你写出高质量代码"这个主题旨在帮助开发者更好地理解和应用设计模式,从而提升代码的质量和可维护性。设计模式不仅对面试有所帮助,也是职场发展中的必备技能,无论你使用哪种开发语言。 设计...