您的位置:首页 > 编程语言

如何优雅的管理以及书写好代码

2016-07-30 15:38 766 查看
        前言:之所以想写这篇文章,是因为看了一些工作好几年的程序员写的代码让人很有点抓狂——难以阅读、无法扩展、容错太差。。。但他们却极力去追求框架、架构、模式等看起来很高大上的东西,我就在想,这样合适么?诚然,这些前人总结的经验是需要去学习和探索,但是,如果基本功没有打牢,把太多的重心放在这些略微有高度的事情上,是否有点舍本逐末??想想,我们程序员的价值在哪里?我们本质上就是要去开发功能、实现需求、满足业务,而达成这一切的基础就是我们写的每一行代码,所以,一个优秀的程序员,一定会有过硬的写代码的水平,这是一个优秀的程序员的基本素养。

        为了提升自己的这一素养,我也在这里给自己一个总结——如何优雅的管理以及书写好javascript代码。

正文从这里开始:

一、清晰的目录结构——可以帮你精准的找到你要找的文件。

目录结构的复杂度应该根据项目的规模大小来确定,如果从整个公司的层面来划分,一个公司可能有好几个部门,不同部门又有好几个不同的项目,这样可以以部门为单位作为顶级目录,然后下面再细分主干、分支,客户端、服务端,然后下面又分pc、H5、app等,进而划分不同项目,然后项目里面才是对应的具体的源代码了,这时候可能要分打包文件、源代码文件、日志文件,源代码里面要分静态资源、视图、路由、库、模块等,静态资源又分js、图片、样式等,可能每个公司的情况不一样,但是这些划分都是要考虑的,并没有最完美的划分,适合自己团队的就是最好的,总之目的是要清晰划分文件类型,一目了然,达到不需要引导就可以很快速掌握整个站点的目录结构,从而找到目标文件。(想强调一点是,目录不要分的太多和太深,如果一个文件夹下面有10个子文件,那就要想想分类是不是太细了,这样有助于找到需要的文件么?)

二、见名知义的命名

不管是文件夹、文件,还是文件里面的函数,适当的命名总能为我们减少很多困惑。文件夹是什么类型的分类划分,就应该冠之以约定俗成的名字,比如,视图就叫views,路由就是routes等。文件名以及其他命名都一样,都有一定的规则,文件名可以就用名词,用英文或者拼音均可,看情况,变量名或者函数名可以用动宾结构,比如searchContactList之类的。每个团队应该有约定的命名规则和方式。

三、源代码(以JavaScript为例)

1、模块化

使用require.js或者sea.js模块化工具,用define将代码封装。

2、函数式编程

将各功能封装成函数,并且要将函数分类,暴露出入口。

3、不要写重复的代码,注意封装

4、留白

适当加空格和换行

5、能不循环就不要循环,能不在循环里面做的事情不要在循环里面做。(看到一个工作五年的同事在for循环里面定义了一串绑定事件,我就泪奔了)

6、心里时刻想着优雅!优雅!优雅!所有,不要写一坨人类看不懂的逻辑,三目运算嵌套不要写太深好不好,最后会把自己搞晕乎的。

7、可读性、拆分,减少嵌套

8、逻辑清晰、易读

9、严格模式

10、适当的注释

11、容错!!!(空格、0、undefined)

12、性能(是否应该过多在意)
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: