zoukankan      html  css  js  c++  java
  • 如何写出高质量的代码 data 组件 函数 注释 命名 变量的次数

    
    今天在将以前文件上传的地方全部 改为新的文件上传的api。
    在改动的过程中,发现代码有很多不合理的地方
    在改的时候,因此也是非常的痛苦的哈。
    
    比如说在data中我有太多的flag标识。俩控制元素的显示和隐藏了。真的是太多了
    这样要不得,虽然代码是可以正常的跑的。但是呢??
    以后不利于他人自己以后的维护。这一点我一定赶紧过来、
    

    1在data中不要写太多的公共数据

    如何解决了:

    能局部显示的,就局部显示吧。
    是不是非要data中的数据取显示了。
    

    2学会写局部组件和公共组件

    我写的代码还有一个问题
    html太多了。小伙子。
    html中相同的部分,你可以将它抽离出去哈
    变成公共的组件。
    
    写组件的好处:可以加速你写代码的速度哈。
    优化你的代码  这样你的代码就不会有很多哈。
    

    3 大量使用自己封装的函数

    这样做的好处是:
    减少代码的冗(rong)余。
    提高自己代码的质量
    

    4写好注释

    当你写一个大的功能时,你应该有良好的注释这个大功能的逻辑和你实现的思路。
    逻辑:是指这个功能的描述
    思路:你是怎样是实现的描述。在你写的代码中应该注意写什么。
    当写这些注释时,你应该使用多行注释
    详细的描述。这样方便你以后维护和修改。
    要不然以后改这一段代码时,你都不知道这是怎么发生的哈。
    此时就是灾难现场。
    
    虽然不需要你每一个方法都要写注释。
    但是你要知道这个方法是用来干什么的。
    重要的逻辑你一定要花时间去写注释说明,以后方便你的阅读
    

    5 命名

    好的命名,可以方便你的阅读。你以后的查找。
    对于同一个文件。
    减少类似的名称。
    例如
    var arr=[1,2,3]
    var tilearr=[{id:1,name:'l'}]
    这样的命名都是不好的。
    因为当你搜索arr时会出现两个arr.
    命名时不要出现这样的状况。
    以后阅读这是非常糟糕的。
    

    6 变量的次数

    在同一个文件中,当你搜索某一个变量时。
    这个变量不要超过7次。当这个变量超过了10次。
    那么维护这一段代码是非常可怕的。
    因为如是这一个变量出现了问题。
    很难发现是哪一个变量出现的问题。
    如果一一查找的话,也要有10次左右,这样也花费时间
    
  • 相关阅读:
    什么是遍历?
    jQuery 尺寸 方法
    jQuery 操作 CSS
    删除元素/内容
    通过 after() 和 before() 方法添加若干新元素
    通过 append() 和 prepend() 方法添加若干新元素
    四个 jQuery 方法:
    设置内容
    jQuery 属性选择器
    jQuery 元素选择器
  • 原文地址:https://www.cnblogs.com/IwishIcould/p/12701595.html
Copyright © 2011-2022 走看看