编写可维护的前端代码

2019-08-16 admin

最近在看JavaScript高级程序设计,看到可维护代码的编写,做一下笔记与总结,方便以后查看。

1.代码约定

1.1可读性

  • 代码的格式化 使用若干个空格来进行缩进,因为制表符在不同编辑器种的显示效果不同
  • 注释 函数和方法 注明参数,返回值,前提假设… 大段代码 复杂的算法 说明算法逻辑,方便别人查看,也方便自己查阅 Hack 说明浏览器的差异,防止别人修改时没考虑到误删…

1.2 变量和函数命名

  • 不要使用没有意义或容易引起歧义的名字,如:foo,doSomething…
  • 变量名尽量用名词,如: car,person…
  • 函数名用动词开始,如:getName(); 返回值为booleanis 开头
  • 变量和函数使用可以说清楚方法作用和变量含义的名称,不要担心长度,后期可以压缩

1.3 变量类型透明

类型透明也就是在变量定义的时候可以知道变量的类型

主要有以下三种方式:

  • 初始化变量

    var found = false; // boolean
    var count = -1; // number
    

    缺点:不能使用在函数声明中的函数参数(现在通过ES6中的函数参数初始化解决)

  • 使用匈牙利标记法 o表示对象,s表示字符串…

    var bFound; // boolean
    var iCount; // int
    

    缺点:代码难以阅读

  • 使用类型注释 类型注释放到变量名右边,初始化前面

    var found /*:Boolean*/ = false;
    var count /*:int*/ = -1;
    

    缺点:不能使用js多行注释

  • 使用typeScript(终极)

2.松散耦合

2.1 解耦HTML/JavaScript

JavaScript中使用HTML

  • 不要使用js插入HTML,可以通过在页面中隐藏元素,当页面渲染后,通过js显示该元素,而不是生成
  • 通过Ajax请求获取HTML

HTML中使用JavaScript

2.2 解耦CSS/JavaScript

  • 通过动态修改样式类,而不是修改特定样式

    // 不建议写法
    element.style.color = 'red';
    element.style.backgroundColor = 'blue';
    
    // 建议写法
    // css
    .dit{
        color: red;
        background-color: blue;
    }
    
    // js
    element.className = 'edit';
    

2.3 解耦应用逻辑/事件处理程序

有以下几条原则:

  • 勿将event对象传给其他方法,只传函数中需要的数据

  • 任何可以在应用层面动作都应该可以在不执行任何事件处理程序的情况下进行

  • 任何事件处理程序都应该处理事件,然后将处理转交给应用逻辑

    // 不建议写法
    function handleKeyPress(event){
        if(event.keyCode === 13){
            var target = event.target;
            var value = 5 * parseInt(target.value);
            if(value > 10){
                document.getElementById('id').style.display = 'block';
            }
        }
    }
    
    // 建议写法
    // 好处:如果我点击鼠标也执行相同逻辑,那么直接调用validateValue就可以了
    // 应用逻辑
    function validateValue(value){
        value = 5 * parseInt(value);
    
        if(value > 10){
            document.getElementById('id').style.display = 'block';
        }
    }
    
    // 事件处理程序
    function handleKeyPress(event){
        if(event.keyCode === 13){
            var target = event.target;
            validateValue(target.value);
        }
    }
    

未完待续…

[转载]原文链接:https://segmentfault.com/a/1190000020088140

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-72630.html

文章标题:编写可维护的前端代码

相关文章
js性能优化 如何更快速加载你的JavaScript页面
确保代码尽量简洁 不要什么都依赖JavaScript。不要编写重复性的脚本。要把JavaScript当作糖果工具,只是起到美化作用。别给你的网站添加大量的JavaScript代码。只有必要的时候用一下。只有确实能改善用户体验的时候用一下。 ...
2015-11-12
10个强大的纯CSS3动画案例分享
我们的网页外观主要由CSS控制,编写CSS代码可以任意改变我们的网页布局以及网页内容的样式。CSS3的出现,更是可以让网页增添了不少动画元素,让我们的网页变得更加生动有趣,并且更易于交互。本文分享了10个非常炫酷的CSS3动画案例,希望大家...
2015-11-16
请前往任务中心完善资料即可激活会员
登录后,点击右上角的用户名,在下拉菜单中可以进去“我的任务” 注册自动激活,本站没有VIP!没有充值!没有推广任务等等 回复即可下载 ...
2015-11-18
v-charts | 饿了么团队开源的基于 Vue 和 ECharts 的图表工具
在使用echarts生成图表时,经常需要做繁琐的数据类型转化、修改复杂的配置项,v-charts的出现正是为了解决这个 痛点。基于Vue2.0和echarts封装的v-charts图表组件,只需要统一提供一种对前后端都友好的数据格式 设置简...
2018-05-24
从2014年的发展来展望JS的未来将会如何
<font face="寰�杞�闆呴粦, Arial, sans-serif ">2014骞达紝杞�浠惰�屼笟鍙戝睍杩呴€燂紝鍚勭�嶈��瑷€灞傚嚭涓嶇┓锛屼互婊¤冻鐢ㄦ埛涓嶆柇鍙樺寲鐨勯渶姹傘€傝繖浜涜��...
2015-11-12
12个你未必知道的CSS小知识
虽然CSS并不是一种很复杂的技术,但就算你是一个使用CSS多年的高手,仍然会有很多CSS用法/属性/属性值你从来没使用过,甚至从来没听说过。 1.CSS的color属性并非只能用于文本显示 对于CSS的color属性,相信所有Web开发人员...
2015-11-12
破解前端面试(80% 应聘者不及格系列):从 闭包说起
不起眼的开始 招聘前端工程师,尤其是中高级前端工程师,扎实的 JS 基础绝对是必要条件,基础不扎实的工程师在面对前端开发中的各种问题时大概率会束手无策。在考察候选人 JS 基础的时候,我经常会提供下面这段代码,然后让候选人分析它实际运行的结...
2017-06-02
ajax为什么令人惊异?ajax的优缺点
使用Ajax的最大优点,就是能在不更新整个页面的前提下维护数据。这使得Web应用程序更为迅捷地回应用户动作,并避免了在网络上发送那些没有改变的信息。 Ajax不需要任何浏览器插件,但需要用户允许JavaScript在浏览器上执行。就像DHT...
2015-11-12
HTML5的5个不错的开发工具推荐
HTML5规范终于在今年正式定稿,对于从事多年HTML5开发的人员来说绝对是一个重大新闻。数字天堂董事长,DCloud CEO王安也发表了文章,从开发者和用户两个角度分析了HTML对两个人群的优势。其实,关于HTML5的开发工具,我们以往的...
2015-11-12
HTML5凭什么可以代替Flash
本世纪初,全球网络建设仍处于早期阶段,发达国家网民刚刚在从窄带向宽带网络过渡。由于网络带宽、PC运算速度等因素限制,早期的网站基本以静态文字和图片内容为主。但随着宽带网络在全球范围快速普及,网民对内容的需求也不断变化。死板的文字加图片的网站...
2015-11-12
回到顶部