本文目录
如何写出简洁、高效的代码
给亲推荐一篇阿里巴巴高级开发工程师竹涧分享的关于代码整洁之道的一篇文，希望对你有所帮助。
Any fool can write code that a computer can understand. Good programmers write code that humans can understand.普通的工程师堆砌代码，优秀的工程师优雅代码，卓越的工程师简化代码。如何写出优雅整洁易懂的代码是一门学问，也是软件工程实践里重要的一环。笔者推荐三本经典的书籍《代码整洁之道 》、《编写可读代码的艺术》、《重构:改善既有代码的设计》，下文重点将从注释、命名、方法、异常、单元测试等多个方面总结了一些代码整洁最佳实践，大部分是笔者总结于以上三本书中的精华，也有部分是笔者工程实践的总结。篇幅有限，本文将总结性给出一些实践建议，后续会有文章来给出一些代码整洁之道的事例。
注释
- 不要给不好的名字加注释，一个好的名字比好的注释更重要
- 不要“拐杖注释”，好代码 》 坏代码 + 好注释
- 在文件/类级别使用全局注释来解释所有部分如何工作
- 一定要给常量加注释
- 团队统一定义标记
- TODO 待处理的问题
- FIXME 已知有问题的代码
- HACK 不得不采用的粗糙的解决方案
- 在注释中用精心挑选的输入输出例子进行说明
- 注释应该声明代码的高层次意图，而非明显的细节
- 不要在代码中加入代码的著作信息，git可以干的事情不要交给代码
- 源代码中的html注释是一种厌物, 增加阅读难度
- 注释一定要描述离它最近的代码
- 注释一定要与代码对应
- 公共api需要添加注释，其它代码谨慎使用注释
- 典型的烂注释
- 不恰当的信息
- 废弃的注释
- 冗余注释
- 糟糕的注释
- 注释掉的代码
- 唯一真正好的注释是你想办法不去写的注释
- 不要有循规式注释，比如setter/getter注释
- 不要添加日志式注释，比如修改时间等信息（git可以做的事情）
- 注释一定是表达代码之外的东西，代码可以包含的内容，注释中一定不要出现
- 如果有必要注释，请注释意图（why），而不要去注释实现（how)，大家都会看代码
- 适当添加警示注释
命名
- 尽可能使用标准命名方法，比如设计模式，通用学术名词等
- 命名要找更有表现力的词
- 使用更专业的词，比如不用get而使用fetch或者download
- 避免空泛的名字，像tmp
- 使用具体的名字来细致的描述事物
- 给变量名带上重要的细节，比如加上单位ms等
- 为作用域大的名字采用更长的名字，作用域小的使用短名字
- 变量类型为布尔值表达加上is，has，can，should这样的词会更明确
- 变量名称长短应该与其作用域对应
- 别害怕长名称，长而具有描述性的名称比短而令人费解的名称好
- 函数名称应该说明副作用，名称应该表达函数，变量或类的一切信息，请不要掩盖副作用，比如CreateAndReturnXXX
方法
- 函数不应该有100行那么长，20行封顶最好
- if else while等控制语句其中代码块应该只有一行，也就是一个函数调用语句
- 函数的锁进层次不应该多于两层
- 一个函数只做一件事，一个函数不应该能抽象出另外一个函数
- 某个公共函数调用的私有函数紧随其后
- 最理想的参数是零参数，最长不要超过三个入参，尽量不要输出参数
- 如果函数传入三个及以上参数最好将其抽象为类
- 标识参数十分丑陋，向函数传入布尔值用于区分不同业务的做法很丑陋，应该拆分为多个函数
- 别返回null值，抛出异常或者返回特殊对象，尽量避免NPE
- 别传入null值
异常与错误
- 抽离try catch包含的代码块，其中代码块抽象为一个函数
- 抛出的每个异常，都应当提供足够的环境说明，已便判断错误的来源与处所
- 不要将系统错误归咎于偶然事件
并发
- 分离并发相关代码与其它代码
- 严格限制对可能被共享的数据的访问
- 避免使用一个共享对象的多个同步方法
- 保持同步区域微小，尽可能少设计临界区
单元测试
- 不要怕单元测试的方法名字太长或者繁琐，测试函数的名称就像注释
- 不要追求太高的测试覆盖率，测试代码前面90%通常比后面10%花的时间少
- 使用最简单的并且能够完整运用代码的测试输入
- 给测试函数取一个完整性的描述性名字，比如 Test _
- 测试代码与生产代码一样重要
- 如果测试代码不能保证整洁，你就会很快失去他们
- 每个测试一个断言，单个测试中断言数量应该最小化也就是一个断言
- FIRST原则
- 快速 Fast
- 独立 Independent 测试应该相互独立
- 可重复 Repeatable 测试应当在任何环境中重复通过
- 自足验证 Self-Validating 测试应该有布尔值输出
- 及时 Timely 最好的方式是TDD
代码结构
- 代码行长度控制在100-120个字符
- 可能用大多数为200行，最长500行的单个文件构造出色的系统
- 关系密切的代码应该相互靠近
- 变量声明应该靠近其使用位置
- 若某个函数调用了另外一个，应该把他们放在一起，而且调用者应该放在被调用者上面
- 自上向下展示函数调用依赖顺序
- 应该把解释条件意图的函数抽离出来，尽可能将条件表达为肯定形式
- 不要继承常量，比如接口中定义常量，不要使用继承欺骗编程语言的作用范围规则
- 模块不应了解它所操作对象的内部情况
- DTO（Data Transfer Objects）是一个只有公共变量没有函数的类
- 对象暴露行为，隐藏数据
- 不要使用“尤达表示法” 如 if(null == obj)，现代编译器对if(obj = null)这样的代码会给出警告
- 一般情况使用if else，简单语句使用三目运算符
- 通常来讲提早返回可以减少嵌套并让代码整洁
设计
- 类应该足够短小
- 类应该满足单一权责原则（SRP），类和模块只有一个修改理由
- 类应该只有少量的实体变量
- 类应该遵循依赖倒置原则 DIP（Dependency Inversion Principle），类应该依赖于抽象而不是依赖于具体细节
- 类中的方法越少越好，函数知道的变量越少越好，类拥有的实体变量越少越好
- 通过减少变量的数量和让他们尽量“轻量级”来让代码更有可读性
- 减少变量
- 缩小变量的作用域
- 只写一次的变量更好，如常量
- 最好读的代码就是没有代码
- 从项目中消除不必要的功能，不要过度设计
- 从新考虑需求，解决版本最简单的问题，只要能完成工作就行
- 经常性地通读标准库的整个API，保持对他们的熟悉程度
- 简单设计
- 运行所有测试
- 不可重复
- 表达了程序员的意图
- 尽可能减少类和方法的数量
- 以上规则按重要程度排列
- 无论是设计系统或者单独模块，别忘了使用大概可工作的最简单方案
- 整洁的代码只提供一种而非多种做一件事的途径，他只有尽量少的依赖。明确定义并提供尽量少的API
- 减少重复代码，提高表达力，提早构建，简单抽象
小结
作为代码整洁之道系列的第一篇，本文从注释、命名、方法，单元测试，并发等视角简单给出了一些最佳实践，下文我们会展开来从每个方面介绍更多的实践事例。相信每一个优秀的工程师都有一颗追求卓越代码的心，在代码整洁工程实践上你有哪些好的建议？数百人协作开发的代码如何保证代码整洁一致性？欢迎大家来讨论。
如何才能写出“高质量”的代码
谢谢邀请，
作为一个已经写了十几年代码的程序员，做好软件不是全部围绕代码而展开，换句话讲一个程序员的程序员优秀不仅仅体现在代码上，更要有内在的编程思想说的层次再高深点就是框架思想。很多初学者都会存在很多疑问，觉得能够写代码就万事大吉了，在能写代码之前会有很多疑问
数学不好能学好编程不？
英语不好能不能学好编程？
这些都是还没入门的疑问，真正入门之后发现这些都不是什么问题，真正决定程序员水平也不是简单的能写多少代码，真正项目实施过程写代码的时间占据不到百分三十，大部分时间是在设计和构思上，当然占据时间最多的是调试以及客户后续提出的需求上面，现在很多人还在纠结是不是要多学习几种编程语言，编程语言本质来讲就是一种工具，主要指导思想还是编程思想。
现实中如何才能写出高质量的代码？
1.良好编程基本功。再高的大厦也得需要强大的编程基础，不一定要掌握多少种编程语言关键要非常熟悉一种编程语言，里里外外都给吃透了，达到这种程度至于掌握几种编程语言就显得不是那么重要了，到了这种程度就可以触类旁通，切换一种新的编程语言也不会费多大事，有事没事就回头看看基础书，越是编程高手越是注重基本功的学习，很多做java的程序员，java编程思想这本书看了不下十几遍，而且还在继续，基础的学习什么时候值得回味。
2.专业知识的雄厚。编程语言只是工具，工具如何才能使用好，还是要看这工具是用来做什么的,比如安全领域可能使用C语言或者C++编程，如果安全专业知识掌握的非常扎实，工具使用起来再更加熟练，才能有高质量的代码出现，要把一个事情做到极致，各个细节点就要落实到位，缺一不可。
3.好的软件框架，软件框架是写出高质量代码的土壤，假如一个能力很强的人，进入一个乱糟糟的公司基本很难发挥出最大的潜能，所以生存土壤很重要，一个优秀的产品一定是代码各个模块有机配合在一起共同做出来的，一个模块的优秀代码优秀，整个产品出问题了意义也不是很大。
4.高质量的代码从来都不是一次性搞定的，都是经过多次的打磨修改出来的，玩过开源的人应该都明白，代码模块不停的升级优化折腾不停，不仅仅是功能的增加更重要的代码质量的提炼，所以想写出高质量代码需要敢对自己下手，对自己要狠一点才能有高质量的代码出来，细心的人可以观察下身边优秀的程序员，看看是不是都是这么做的。
做到以上四点，坚持下去写出来的代码质量不会差，当然还要懂得去阅读别人写的优秀代码，开始看的时候不一定能看得懂，不能大块的看懂就切块去看去学习，以前有个linux内核爱好者，整体看linux内核代码，有一天看到他十分开心的样子，问发生了什么事情，说看懂了linux内核里面的内存是如何管理的了，然后拉着我给我讲了半天，虽然没听懂但也坚持听到最后，毕竟代码能写的前提是能看懂，所以开源社区的代码如果能看懂就是一个非常大的进步，然后一步步的掌握起来，格局放大一定做出更大的事情来。
32岁了想自学IT行业，懂简单的代码，现在起步会晚吗
我认为不晚，先不说这个专业适合多大年龄的人就业，你先换个角度想想，你才32岁，眼光放长远，专心学习5年才37岁，更何况你还有一定基础，还是自己爱好的专业，学好学成自有用武之地。
怎样编写一个简单的C语言程序，
第一步：建立新文件，这个直接就是CPP的，；第二部：保存（避免文件丢失或找不到位置）；第三步：编写代码第四步：然后确定没有问题后，点构建菜单的构建，或者直接按F5建议你用VC6.0或者VS2008比较好
如何使用vb编写一个给好朋友的代码
通过程序编码写信。可以分为三步，第一步，设计程序的界面这是最有趣的一步，你根据你要实现的功能画出程序的界面，很有点摆积木的味道。第二步，编写代码最枯燥的一步，根据程序的功能，为每个控件元素编写代码，这一步是程序设计的关键所在。第三步，发布应用程序，为你的程序创建安装项目。如果是自己使用，这一步可忽略。
怎么写代码
零基础的人想要写代码首先需要进行一定的学习，了解一些基础的编程知识，选择适合自己的程序语言，之后通过不断的学习就可以写代码。从简单的、直接的几行十几行程序开始，比如计算器；到复杂的小工具，比如大数计算器。这个过程中逐渐明白数组、指针、内存布局、函数，了解递归、栈、链表，然后学基本的数据结构。C语言也好，python也好，得学会把自己的思考用程序实现。举个例子，想制定计划表，安排自己的时间，那这个问题就可以写个程序来实现；想做笔记、管理自己的文件，这也是一个程序。从简单的、直接的几行十几行程序开始，比如计算器；到复杂的小工具，比如大数计算器。代码组合源代码作为软件的特殊部分，可能被包含在一个或多个文件中。一个程序不必用同一种格式的源代码书写。例如，一个程序如果有C语言库的支持，那么就可以用C语言；而另一部分为了达到比较高的运行效率，则可以用汇编语言编写。较为复杂的软件，一 般需要数十种甚至上百种的源代码的参与。为了降低种复杂度，必须引入一种可以描述各个源代码之间联系，并且如 何正确编译的系统。在这样的背景下，修订控制系统（RCS）诞生了，并成为研发者对代码修订的必备工具之一。
如何写代码
1、是选择学习的编程语言，计算机语言的种类繁多，但是大体可以分为机器语言，汇编语言，高级语言以及脚本语言。2、学习编程的过程中入门是一个很重要的过程，尤其是对于编程一点都不了解的朋友，看着那些密密麻麻看不懂的代码，什么热情都被浇灭了，从而就此放弃了学习编程，因此选择编程的入门方式十分重要。3、可以从网上获取到我们需要的知识，自然也包括了学习编程，现在很多编程语言都出了视频教程，而且还不止一家，我们可以挑选最适合自己的视频教程来学习。4、光看不练假把式，每当我们看完一节视频教程的时候，我们就应该把讲述的这些内容自己多练习几遍，直到完全掌握，这样再去看下一节的视频教程，千万不要光看不练，我们的目的不是为了看视频而看视频，而是为了掌握知识，只有掌握了才是自己的。5、当我们累计到一定程度的知识之后就可以做一个简单的项目了，一是为了巩固所学的知识，把我们所学的知识串联起来，二是为了以后的工作做准备，毕竟早点熟悉以后的工作内容才能早点上手。编程最容易让人放弃的就是两个阶段，一个就是入门阶段，一个就是觉得什么都会学了，但是什么都做不成的阶段，入门的话我们可以选择视频教程，相对于书籍来说小编觉得比较好，如果遇到第二个阶段可以做个项目，把各个知识点连接起来，在做项目的过程中查漏补缺，这样做的话应该有利于你的编程学习之路。
