前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >很实用的前端开发规范

很实用的前端开发规范

作者头像
前端迷
发布2018-10-29 16:16:13
4630
发布2018-10-29 16:16:13
举报
文章被收录于专栏:前端迷前端迷

注释规范

规范的注释很重要

代码是写给人看的,顺便给机器运行,多谢注释可以增加代码的可读性


/** 
**************
 * @func 教师端请假功能 ;
 * @param {String} token 教师端头部的token;
 * @param {string} a - 参数a;
 * @param {number} b=1 - 参数b默认值为1;
 * @param {string} c=1 - 参数c有两种支持的取值</br>1—表示x</br>2—表示xx;
 * @param {object} d - 参数d为一个对象;
 * @param {string} d.e - 参数d的e属性;
 * @param {string} d.f - 参数d的f属性;
 * @param {object[]} g - 参数g为一个对象数组;
 * @param {string} g.h - 参数g数组中一项的h属性;
 * @param {string} g.i - 参数g数组中一项的i属性;
 * @param {string} [j] - 参数j是一个可选参数;
 * @description  2018年4月19日被frank开发于dev_sprint65分支,
 *   XX年XX月被XX在xx分支修改(原因或者修改的功能);
 ****************/

变量命名规范

1.标准变量命名使用驼峰式命名 eg. let thisIsMyName; 2.常量全部大写,并使用下划线连接 eg. const MAX_COUNT = 10;

项目规范

变量声明尽量提在函数首部,用一个var声明,不允许出现连着的两个var声明(也包括let,const)

function doSomethingWithItems(items) {
    // use one var
    let value = 10,
        result = value + 10,
        i,
        len;

    for (i = 0, len = items.length; i < len; i++) {
        result += 10;
    }
}

undefind使用规范(永远不要直接使用undefined进行变量判断,使用typeof和字符串’undefined’对变量进行判断。)

// not good
if (person === undefined) {
    ...
}

// good
if (typeof person === 'undefined') {
    ...
}

用’===’和’!==’代替’==’, ‘!=’

使用对象的属性简写

const job = 'FrontEnd'
// bad
const item = {
  job: job
}
// good
const item = {
  job
}

使用拓展运算符 … 复制数组

// bad
const items = []
const itemsCopy = []
const len = items.length
let i
// bad
for (i = 0; i < len; i++) {
  itemsCopy[i] = items[i]
}
// good
itemsCopy = [...items]

render使用

render: (h, params) => {
    return h('div', [
        h('span', {
            attrs: {
                class: "table_details"
            },
            on: {
                click: () => {
                    this.edit(params.index)
                }
            }
        },),
        h('span', {
            attrs: {
                class: "table_continue"
            },
            on: {
                click: () => {
                    this.show(params.index)
                }
            }
        },),
        h('span', {
            attrs: {
                class: "table_more no_border_right"
            },
            on: {
                click: () => {
                    this.remove(params.row.id)
                }
            }
        },),
        h('Poptip', {
            props: {
                title:"项目变更",
                content:"项目迁出",
                placement:"bottom-end"
            },
            on: {
                'on-ok': () => {
                }
            }
        }, [
            h('span', {
                attrs: {
                    class: "table_more no_border_right"
                }
            })
        ])
    ])
}
本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2018-10-25,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 前端迷 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 注释规范
    • 规范的注释很重要
    • 变量命名规范
    • 项目规范
    领券
    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档