当前位置:首页 > 资讯 > info6 > 正文

如何写出程序员无法维护的代码?

发表于: 2016-03-11 ? 作者:cheetah023 ? 来源:转载 ? 浏览:
摘要: 文章写得很幽默,同时指出了很多编程上应该注意的地方。--------------------------------------------------------------------------------------------------程序命名容易输入的名字。比如:Fred,asdf单字母的变量名。比如:a,b,c,x,y,z(陈皓注:如果不够用,可以考虑a1,a2,a3,a4,….)

文章写得很幽默,同时指出了很多编程上应该注意的地方。

--------------------------------------------------------------------------------------------------

程序命名


容易输入的名字。比如:Fred,asdf


单字母的变量名。比如:a,b,c, x,y,z(陈皓注:如果不够用,可以考虑a1,a2,a3,a4,….)


有创意地拼写错误。比如:SetPintleOpening, SetPintalClosng。这样可以让人很难搜索代码。


抽象。比如:ProcessData, DoIt, GetData… 抽象到就跟什么都没说一样。


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


随机大写字母。比如:gEtnuMbER..


重用命名。在内嵌的语句块中使用相同的变量名有奇效。


使用重音字母。比如:int ínt(注:第二个 ínt不是int)


使用下划线。比如:_, __, ___。


使用不同的语言。比如混用英语,德语,或是中文拼音。


使用字符命名。比如:slash, asterix, comma…


使用无关的单词。比如:god, superman, iloveu….


混淆l和1。字母l和数字1有时候是看不出来的。



伪装欺诈


把注释和代码交织在一起。

for(j=0; j

{

total += array[j+0 ];

total += array[j+1 ];

total += array[j+2 ]; /* Main body of

total += array[j+3]; * loop is unrolled

total += array[j+4]; * for greater speed.

total += array[j+5]; */

total += array[j+6 ];

total += array[j+7 ];

}

隐藏宏定义。如:#define a=b a=0-b,当人们看到a=b时,谁也想不到那是一个宏。


换行。如下所示,下面的示例使用搜索xy_z变得困难。

#define local_var xy\

_z // local_var OK


代码和显示不一致。比如,你的界面显示叫postal code,但是代码里确叫 zipcode。


隐藏全局变量。把使用全局变量以函数参数的方式传递给函数,这样可以让人觉得那个变量不是全局变量。


使用同意词。如:

#define xxx global_var // in file std.h?

#define xy_z xxx // in file ..\other\substd.h?

#define local_var xy_z // in file ..\codestd\inst.h

使用相似的变量名。如:单词相似,swimmer 和 swimner,字母相似:ilI1| 或 oO08。parselnt 和 parseInt, D0Calc 和 DOCalc。还有这一组:xy_Z, xy__z, _xy_z, _xyz, XY_Z, xY_z, Xy_z。


重载函数。使用相同的函数名,但是其功能和具体实现完全没有关系。


操作符重载。重载操作符可以让你的代码变得诡异,感谢CCTV,感谢C++。这个东西是可以把混乱代码提高到一种艺术的形式。比如:重载一个类的 ! 操作符,但实际功能并不是取反,让其返回一个整数。于是,如果你使用 ! ! 操作符,那么,有意思的事就发生了—— 先是调用类的重载 ! 操作符,然后把其返回的整数给 ! 成了 布尔变量,如果是 !!! 呢?呵呵。


#define。看过本站那些混乱代码的文章,你都会知道宏定义和预编译对于写出不可读的代码的重大意义。不过,一个具有想像力的东西是——在头文件中使用预编译来查看这个头文件被include了几次,而被include不同的次数时,其中的函数定义完全不一样。

#ifndef DONE

#ifdef TWICE

// put stuff here to declare 3rd time around

void g(char* str);

#define DONE

#else // TWICE

#ifdef ONCE

// put stuff here to declare 2nd time around<

void g(void* str);

#define TWICE

#else // ONCE

// put stuff here to declare 1st time around

void g(std::string str);

#define ONCE

#endif // ONCE

#endif // TWICE

#endif // DONE

文档和注释


在注释中撒谎。你不用真的去撒谎,只需在改代码的时候不要更新注释就可以了。


注释明显的东西。比如:/* add 1 to i */。(参看本站的“五种应该避免的注释”)


只注释是什么,而不是为什么。


不要注释秘密。如果你开发一个航班系统,请你一定要保证每有一个新的航班被加入,就得要修改25个以上的位置的程序。千万别把这个事写在文档中。


注重细节。当你设计一个很复杂的算法的时候,你一定要把所有的详细细设计都写下来,没有100页不能罢休,段落要有5级以上,段落编号要有500个以上,例如:1.2.4.6.3.13 – Display all impacts for activity where selected mitigations can apply (short pseudocode omitted). 这样,当你写代码的时候,你就可以让你的代码和文档一致,如:Act1_2_4_6_3_13()


千万不要注释度衡单位。比如时间用的是秒还是毫秒,尺寸用的是像素还是英寸,大小是MB还是KB。等等。另外,在你的代码里,你可以混用不同的度衡单位,但也不要注释。


Gotchas。陷阱,千万不要注释代码中的陷阱。


在注释和文档中发泄不满。



程序设计


Java Casts。Java的类型转型是天赐之物。每一次当你从Collection里取到一个object的时候,你都需要把其转回原来的类型。因些,这些转型操作会出现在N多的地方。如果你改变了类型,那么你不一定能改变所有的地方。而编译器可能能检查到,也可能检查不到。

原文转自:http://www.it-home.org/article-2502-1.html

如何写出程序员无法维护的代码?

版权所有 IT知识库 CopyRight ? 2009-2015 IT知识库 IT610.com , All Rights Reserved. 京ICP备09083238号