Skip to content

Latest commit

 

History

History
342 lines (251 loc) · 20.1 KB

编程之道.md

File metadata and controls

342 lines (251 loc) · 20.1 KB

编程之道

代码风格

参考官方：PEP 8 -- Style Guide for Python Code

python之禅

Python里输入

import this

结果为：

Beautiful is better than ugly.
# 优美胜于丑陋（Python以编写优美的代码为目标）
Explicit is better than implicit.
# 明了胜于晦涩（优美的代码应当是明了的，命名规范，风格相似） 
Simple is better than complex.
# 简洁胜于复杂（优美的代码应当是简洁的，不要有复杂的内部实现） 
Complex is better than complicated.
# 复杂胜于凌乱（如果复杂不可避免，那代码间也不能有难懂的关系，要保持接口简洁）
Flat is better than nested.
# 扁平胜于嵌套（优美的代码应当是扁平的，不能有太多的嵌套） 
Sparse is better than dense.
# 间隔胜于紧凑（优美的代码有适当的间隔，不要奢望一行代码解决问题） 
Readability counts.
# 可读性很重要（优美的代码是可读的） 
Special cases aren't special enough to break the rules.
Although practicality beats purity.
# 即便假借特例的实用性之名，也不可违背这些规则（这些规则至高无上） 
Errors should never pass silently.
Unless explicitly silenced.
# 不要包容所有错误，除非你确定需要这样做（精准地捕获异常，不写except:pass风格的代码） 
In the face of ambiguity, refuse the temptation to guess.
# 当存在多种可能，不要尝试去猜测 
There should be one-- and preferably only one --obvious way to do it.
# 而是尽量找一种，最好是唯一一种明显的解决方案（如果不确定，就用穷举法） 
Although that way may not be obvious at first unless you're Dutch.
# 虽然这并不容易，因为你不是 Python 之父（这里的Dutch是指Guido）
Now is better than never.
Although never is often better than *right* now.
# 做也许好过不做，但不假思索就动手还不如不做（动手之前要细思量）
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
# 如果你无法向人描述你的方案，那肯定不是一个好方案；反之亦然（方案测评标准） 
Namespaces are one honking great idea -- let's do more of those!
# 命名空间是一种绝妙的理念，我们应当多加利用（倡导与号召）

经验分享

  • 在电脑里安装两套输入法，编程的时候，将中文输入法彻底关掉，确保任何快捷键都不会将其转换成中文输入法，防止中文类似符号引起混淆。我平时用搜狗输入法，编程的时候用QQ输入法，设置改成中文状态下使用英文符号。比如：中文 :（）； English: () ;一点点小错误，就有可能让你多花一两个小时在没有意义的事上，人生苦短，尽量避免低级错误。

  • 变量严格区分大小写

  • 重在对模型算法的掌握，pthon只是工具，matlab、R、stata、eviews都类似

  • 代码一定要一行行敲,尽量不要复制粘贴,成为大神的途径只有一个:犯过所有人都犯的错误，想不犯错，唯手熟尔

  • 规范化自己的代码，少点个人风格，多点通用规矩。例如了解变量的命名，最好不要用拼音，尽量使用英文，让人看到变量名就大体了解其含义，单词之间用_进行连接，宁可变量名长，也不要让变量名短得让人无法推测其含义。

    两种命名方式:

    第一种:StudentName(驼峰命名法)

    第二种:student_name

    不要是xuesheng，SN，sum

  • 注意缩进,保证代码有较好的阅读感受，python强制缩进

  • 尽可能杜绝重复代码，凡是需要用至少两次的代码，给它单独做一个类或函数。

  • 不要怕报错,认真看报错信息,实在看不懂百度，谷歌

  • 程序不等于数据结构加算法，而等于搜索引擎加英语。

  • 玩算法的码农，打拼靠蓝条，像是法师。数学就等于蓝条最大值，数学差，魔法值不高，很快就到瓶颈了。外语影响回蓝速度。经验和智力加急速和穿透的。不玩算法的码农，像是战士，打拼靠血条，体质加生命，精神加生命回复，经验和敏捷加急速和破甲。

  • 多读别人的优秀代码，拿别人的优秀代码和自己的代码进行对比，学习别人的长处，吸收经验。

  • 尝试着做内容的生产者，尝试着写一些教程或笔记，分享给社区，不要只做社区内容的吸收者，还要不断地生产内容，回馈社区给你的帮助。

  • 没有任务的时候，也不要闲下来，去开发点你喜欢的东西，从中挑战自己，增长经验。

  • 不要过分依赖教程，要学会看官方文档。凡是能被做成教程的东西，往往已经过时了，最新的技术，最新发布的标准，往往没有现成的教程，你需要去认真阅读官方文档，那里的东西才是最权威的。

  • 不要参与语言好坏的争论，人们往往偏向于喜欢自己用得熟练，用得多的那个语言，语言好坏之争，就和争谁的女朋友漂亮一样，我当然觉得自己的女朋友最漂亮，但是别人并不这么觉得。

  • 当你有什么需求的时候，往往别人也有这个需求，而且往往也有了相应的工具去解决你这个需求，所以不要闭关造轮子，先从网络里搜搜看看有没有现成的轮子。

  • 你的开发电脑，CPU可以差些，但内存最好大些，推荐至少要8G，甚至推荐10G往上走，你常常需要同时打开一堆浏览器页面和一个IDE甚至还有别的一堆工具，如果你做过安卓开发，AndroidStudio动辄就调用你电脑2-3G的内存，一般的4G电脑肯定是吃不消的，严重降低开发体验，但也并不是让你换电脑，内存条了解一下。

  • 保持一个健康，干净的电脑状态，硬盘里的文件存储要有调理，容易寻找指定文件，降低文件丢失概率，加快文件寻找速度。

  • C盘快满了的话，可以通过分区助手将别的磁盘的空间送给C盘。

  • 可以考虑用一个电脑架子，防止乌龟颈，保护颈椎。

  • 下载一个护眼宝，保护视力，毕竟每天盯着电脑，眼睛受不了。

  • 可以多看看一些常用软件，很多时候可以节省你大量时间

  • 想清楚之后再动手，不要编程到一半，想到还有更好的思路，这样还要推倒重来。

  • 不要只看书和视频，要多动手去做

  • 多读一些官方文档还有python标准库

  • 最好不要一个人学，很容易中途就放弃，要找到组织，比如加一个群，里面可能会有很多志同道合的人。

  • 遇到不会的问题，要学会自己搜寻答案

如何在代码里下毒

下毒要点

  1. 独特的算法，个性的变量命名。
  2. 复杂的结构，畸形的文件路径。
  3. 无常的缩进，空空如也的注释。
  4. 混乱的格式，从不换行的语句。
  5. 磅礴的代码，无数的羊肠小道。
  6. 意外的编译，庞大的黄色感叹。

开始下毒

程序命名

  1. 容易输入的变量名。比如：Fred，asdf

  2. 单字母的变量名。比如：a,b,c, x,y,z（如果不够用，可以考虑a1,a2,a3,a4,….）

    <p class = 'c1'></p> 
<p class = 'c2'></p> 
<p class = 'c3'></p> 
...
<p class = 'c99'></p> 
<p class = 'c100'></p>

  3. 有创意地拼写错误。比如：SetPintleOpening， SetPintalClosing。这样可以让人很难搜索代码。

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

  5. 缩写。比如：WTF，RTFSC …… （使用拼音缩写也同样给力，比如： BT，TMD，TJJTDS）

  6. 随机大写字母。比如：gEtnuMbER..

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

  8. 使用重音字母。比如：int ínt（第二个 ínt不是int）

  9. 使用下划线。比如：_, __, ___。

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

    // 狗叫
function dogjiao(){
System.out.println("我xiexie你了");
System.out.println("你keqi尼玛吶！");
}

    记住你的拼音得过十级哦！

    // 这是一个和飞机有关的代码，感觉迟早得掉下来！
let poguanzi = "";
let lanchibang = "";
let zhuanbuqilaidelunzi = "";
// 想象不出该程序员都经历了些什么
function bufaqianlaoshi() {}
function meipiyanlaoshifaqian() {}
function nengbunengfaqian() {}
// 对爱情的渴望是每个程序猿的本能！！
class haoxihuangebinvhai{};
class gebinvhaichuanhongyifu{};
class gebinvhaihaimeinanpengyou{};
let yi= 1;
let er= 2;
...

  11. 使用字符命名。比如：slash, asterix, comma…

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

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

伪装欺诈

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

     for(j=0; j<array_len; j+ =8)
        {
            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 ];
        }

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

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

  4. 使用相似的变量名。如：

    • 单词相似，swimmer 和 swimner；
    • 字母相似：ilI1| 或 oO08。parselnt 和 parseInt， D0Calc 和 DOCalc。还有这一组：xy_Z, xy__z, _xy_z, _xyz, XY_Z, xY_z, Xy_z。

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

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

  7. 一段只能活三年的代码！

    if(year === 2017){***}
else if(year === 2018){***}
else if(year === 2019){***}

文档和注释

  1. 在注释中撒谎。不用真的去撒谎，只需在改代码的时候不更新注释就可以了。
  2. 注释里面写废话。比如：/* add 1 to i */
  3. 只注释是什么，而不是为什么。
  4. 不要注释秘密。如果你开发一个航班系统，请你一定要保证每有一个新的航班被加入，就得要修改25个以上的位置的程序。千万别把这个事写在文档中。
  5. 注重细节。当你设计一个很复杂的算法的时候，你一定要把所有的详细设计都写下来，没有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等等。另外，在代码里，还可以混用不同的度衡单位，但也不要注释。
  6. Gotchas。陷阱，千万不要注释代码中的陷阱。
  7. 在注释和文档中发泄不满。

程序设计

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

  2. 利用Java的冗余。比如：Bubblegum b = new Bubblegom(); 和 swimmer = swimner + 1; 注意变量间的细微差别。

  3. 从不验证。从不验证输入的数据，从不验证函数的返回值。这样做可以向大家展示你是多么的信任公司的设备和其它程序员

  4. 不要封装。调用者需要知道被调用的所有的细节。

  5. 克隆和拷贝。为了效率，你要学会使用copy + paste。你几乎都不用理解别人的代码，你就可以高效地编程了。

  6. 巨大的listener。写一个listener，然后让你的所有的button类都使用这个listener，这样你可以在这个listener中整出一大堆if…else…语句，相当的刺激。

  7. 使用三维数组。如果你觉得三维还不足够，你可以试试四维。

  8. 混用。同时使用类的get/set方法和直接访问那个public变量。这样做的好处是可以极大的挫败维护人员。

  9. 包装，包装，包装。把你所有的API都包装上6到8遍，包装深度多达4层以上。然后包装出相似的功能。

  10. 没有秘密。把所有的成员都声明成public的。这样，你以后就很难限制其被人使用，而且这样可以和别的代码造成更多的耦合度，可以让你的代码存活得更久。

  11. 排列和阻碍。把drawRectangle(height, width) 改成 drawRectangle(width, height)，等release了几个版本后，再把其改回去。这样维护程序的程序员们很快就不明白哪一个是对的。

  12. 把变量改在名字上。例如，把setAlignment(int alignment)改成，setLeftAlignment, setRightAlignment, setCenterAlignment。

  13. 保留你所有的没有使用的和陈旧的变量，方法和代码。

  14. Final你所有的子结点的类，这样，当你做完这个项目后，没有人可以通过继承来扩展你的类。java.lang.String不也是这样吗？

  15. 避免使用layout。这样就使得我们只能使用绝对坐标。如果你的老大强制你使用layout，你可以考虑使用GridBagLayout，然后把grid坐标hard code.

  16. 环境变量。如果你的代码需要使用环境变量。那么，你应该把你的类的成员的初始化使用环境变量，而不是构造函数。

  17. 使用全局变量。1）把全局变量的初始化放在不同的函数中，就算这个函数和这个变量没有任何关系，这样能够让我们的维护人员就像做侦探工作一样。2）使用全局变量可以让你的函数的参数变得少一些。

  18. 配置文件。配置文件主要用于一些参数的初始化。在编程中，我们可以让配置文件中的参数名和实际程序中的名字不一样。

  19. 膨胀你的类。让你的类尽可能地拥有各种臃肿和晦涩的方法。比如，你的类只实现一种可能性，但是你要提供所有可能性的方法。不要定义其它的类，把所有的功能都放在一个类中。

  20. 使用子类。面向对象是写出无法维护代码的天赐之物。如果你有一个类有十个成为（变量和方法）你可以考虑写10个层次的继承，然后把这十个属性分别放在这十个层次中。如果可能的话，把这十个类分别放在十个不同的文件中。

  21. 混乱你的代码。使用XML。XML的强大是无人能及的。使用XML你可以把本来只要10行的代码变成100行。而且，还要逼着别人也有XML。（参看，信XML得永生，信XML得自信）

  22. 分解条件表达式。如：把 a==100分解成，a>99 && a<101

  23. 学会利用分号。如：if ( a );else;{ int d; d = c;}

  24. 间接转型。如：把double转string，写成new Double(d).toString() 而不是 Double.toString(d)

  25. 大量使用嵌套。一个NB的程序员可以在一行代码上使用超过10层的小括号（），或是在一个函数里使用超过20层的语句嵌套{}，把嵌套的if else 转成 [? :] 也是一件很NB的事。

  26. 长代码行。一行的代码越长越好。这样别人阅读时就需要来来回回的

  27. 不要过早的return。不要使用break，这样，你就需要至少5层以上的if-else来处理错误。

  28. 不要使用{}。不要在if else使用{}，尤其是在你重量地使用if-else嵌套时，你甚至可以在其中乱缩进代码，这样一来，就算是最有经验的程序员也会踩上陷阱。

    //如果标志为真，就返回true
if(flag)
 return true;
return false;
function zhuandaxie(str) {
 if (char == "a") {
 return 'A';
 } else if (char == "b") {
 return 'B';
 }
 ...
}
var sousuo = document.querySelector("#sousuo").value;
if(sousuo == '请输入搜索条件'){
 alert("请输入搜索条件");
}
if(sousuo == ''){
 alert("请正确输入搜索条件");
}

  29. 琐碎的封装。比较封装一个bool类，类里面什么都做，就是一个bool.

  30. 循环。千万不可用for(int i=0; i<n; i++)使用while代替for，交换n和i，把<改成<=，使用 i–调整步伐 。

  31. 最清新的功能。

    <a href="javascript:alert('清除成功')">清空缓存</a>
<a href="javascript:alert('您的投诉已收到！给您带来不便我们深表遗憾！')">投诉</a>

测试

  1. 从不测试。千万不要测试任何的出错处理，从来也不检测系统调用的返回值。
  2. 永远不做性能测试。如果不够快就告诉用户换一个更快的机器。如果你一做测试，那么就可能会要改你的算法，甚至重设计，重新架构。
  3. 不要写测试案例。不要做什么代码覆盖率测试，自动化测试。
  4. 测试是懦夫行为。一个勇敢的程序员是根本不需要这一步的。太多的程序员太害怕他们的老板，害怕失去工作，害怕用户抱怨，甚至被起诉。这种担心害怕直接影响了生产力。如果你对你的代码有强大的信心，那还要什么测试呢？真正的程序员是不需要测试自己的代码的。

其他

  1. 你的老板什么都知道。无论你的老板有多SB，你都要严格地遵照他的旨意办事，这样一来，你会学到更多的知识以及如何写出更加无法维护的代码。
  2. 颠覆Help Desk。你要确保你那满是bug的程序永远不要被维护团队知道。当用户打电话和写邮件给你的时候，你就不要理会，就算要理会，让用户重做系统或是告诉用户其帐号有问题，是标准的回答。
  3. 闭嘴。对于一些像y2k这样的大bug，你要学会守口如瓶，不要告诉任何人，包括你的亲人好友以及公司的同事和管理层，这样当到那一天的时候，你就可以用这个bug挣钱了。
  4. 忽悠。你会学会忽悠，就算你的代码写得很烂，你也要为其挂上GoF设计模式的标签，就算你的项目做得再烂，你也要为其挂上敏捷的标签，让整个团队和公司，甚至整个业界都开始躁动，这样才能真正为难维护的代码铺平道路。

总之，我们的口号是—— Write Everywhere，Read Nowhere。只要能跑起来的代码，就是好代码！没有最烂，只有更烂。

作者：MChopin
链接：https://www.jianshu.com/p/635fcf4fe594