怎样写出优良性好的代码

怎样写出优良性好的代码

1. 全局的架构

很多时候是由于对整个项目没有完整的构思，导致后面功能的扩展打乱现有的代码，后面阅读或修改看着好乱、不清晰。

①　项目的操作流程

②　理解项目的开发用意

③　开发的程序要符合人们的操作习惯

通过对项目的全面理解开始架构项目。

2. 项目架构

这么讲的项目架构是项目的文件路径整的思路，应尽量不破坏现有架构的结构，让人看着就明白整体的结构是怎样的。比如，图片、样式、JavaScript，这样分开会结构清晰很多。项目中是包含很多页面的，同时每个页面也包含各自的JavaScript和css等，那么可以分开不同的页面路径文件夹，当然还包含其他资源也是一样可以放在文件夹中，这么我们按照页面名字区分。现在开发中我们应该都用到构建工具或者工程化工具，比如压缩，压缩文件可以放相同文件夹中，只要命名不一样就行，就像min.js加min说明是压缩后的文件。

3. 公共方法、资源

公共方法和资源主要包括JavaScript公共方法、less公共方法。可以单独构建对于它们的公共方法。这里还可以分为各种方法的封装，比如，JavaScript的公共方法可能包括一些基本方法的封装、ajax的封装，这是可以分开构建，一个是javascript的com.js方法和ajax.js封装两个，用的时候就可以直接引入对应的方法资源。这么可以就涉及到一些到底哪些是公共方法的问题了，那就是把一些多处使用的代码抽离出来封装成公共方法，在使用的时候就可以直接调用节省了很多代码。这个地方我会出现的情况往往就是贪图一时的方便就不管了，导致后面的修改或者阅读性很不好，这个方面是要及时改错。

4. 代码的书写指导原则

①　可读性

可读性就是书写的代码要就有优良的可读性，让人一看就明白这个地方是干嘛的。这里有一些建议总结，比如，名字的起名要具有实际的意义，看名知意。在业务逻辑的处理过程中应尽量书写容易理解的代码，让代码清楚的阅读起来很容易明白这个过程的干嘛的。

②　简洁性

简洁的代码可以让程序更加的小巧，而且跑起来不容易出bug，或者找起来也容易发现，以及后面修改也更加清晰，所以看得出来具有简洁性的代码是多么的重要。以最少的代码量做相同的工作不是更加好麽。(*￣︶￣)

③　注释

就像上面所说的这些，在复杂的逻辑中我们应适当的加一些注释，方便我们下次阅读更加容易。注释的多少应根据代码的多少、容易程度、逻辑的复杂度进行相应的调整。

④　风格

代码要保持统一的风格。不要这个地方一种风格，别的地方又一种风格。

5. JavaScript的书写

①　对象封装

Js中的方法可以用对象的方法进行封装，这样看起来会整洁干净一点。比如，可以声明一个对象，然后在对象中书写方法或者声明变量，使用的时候再对象点方法的方式进行调用。

②　方法封装

顾名思义，就是Js中书写的代码进行方法封装，不要暴露逻辑代码在方法体外。比如，事件处理、事件处理对应的方法以及事件处理过程中使用到的公共方法和逻辑处理，我们都可以进行方法的封装，不要暴露在外面。

③　处理逻辑不要暴露

这个就是前两点说过的，代码处理不要暴露在方法体外。

6. Css、less的书写

①　共用原则

就是页面构建中有相同的其实使用到的css是差不多的时候，可以把相同的样式进行抽离共同使用，比如说一个登陆界面和一个注册界面其实是差不多的，有一部分是相同的样式可以抽离共用，可以减少很多代码，加快界面渲染速度。在less等预编译工具中，因为可以引入使用及特性，可以封装更多的公共样式，比如，定义变量的方式定义一些颜色，因为可以传参的方式调用，可以定义一组样式调用使用，比如，定义一组使用position方式居中盒模型的方式。

②　class、id的使用

语义化，看了就明白这是什么的盒模型。下划线，一般组合多个英文单词的时候或者组合多个意思的时候。在css中避免多级嵌套书写。在less中多级嵌套使用，如果没使用的可以不加上这级嵌套。

③　样式的架构及整洁性

按照盒模型的区块进行分类，如果使用less可以定义公共样式。

7. Html的书写

保持简洁，按照页面结构划分不同的区域。便签的使用要尽量简洁、区块式划分。

8. 状态管理和用数据结构管理状态

对应界面JavaScript中的状态管理，也就是声明变量可以声明在一个对象中，或者对应组的变量声明在对象中，这样防止变量的分散，方便以后理解和管理变量。数据的结构也是使用对象封装，不要太过于暴露在外面看着很乱。

9. 书写代码前要的一个思考再书写

有一个前提的思考能让程序的规划更合理，符合程序设计。在之前的项目中可能就是缺少这步，导致代码往后的书写越来越混乱，改起来很困难。

10. 对代码优良性的一些思考

①　简洁性

②　系统性

③　规范性

④　优良性

⑤　重用性