美文网首页KAMS
kams前端代码规范

kams前端代码规范

作者: cobantou | 来源:发表于2016-12-02 21:40 被阅读32次

1.由于各种原因,前端代码规范我是不准备写的,原因之一是我不准备以一个前端的要求去限制大家。但是,我还是看到了一些不好的代码,所以还是稍微啰嗦几句吧。
2.由于大家的代码并不是太多,所以问题暴露的不全,此规范会根据暴漏的问题增加而逐渐增加。毕竟规范是用来矫正一些不一致的情况的。

css

  1. 由于前端采用了Semantic库作为样式基准,所以大部分的样式是不用写的,如果你需要写css,请把css写在<style></style>里面,如果样式太多,应该抽出来一个css文件,并放在css/pages文件目录下。
  2. 不允许直接在html元素上写行内css,如<div style="color:red"></div>,css必须定义在class上面。
  3. 谨慎使用!important,除非你知道在做什么;important会提高css的权重,但是如果把important定义在一些比较通用的class上面,将是一场灾难。

js & html

  1. js钩子
    最好以class名为js-开头作为js钩子,如:<div class="js-showPersonList">
    也可以使用id作为js钩子;
    不允许用不以js-开头的class为js钩子,如:<div class="red">,然后这样绑定事件$(".red").on("click",function(){...}),这个代码是不ok的。

  2. 注释
    应该在一个参数较多的函数上写好注释,如:

/**
 * 渲染人员列表
 * @param {Object} data 人员数据
 * @param {String} name 标题名
 * @param {Array} list 选项数组
 */
function renderPersonList(data,name,list){
    ...
}

其他

要求不多,还是希望大家多看看我写的另外几篇文档,关于表单、异步、弹窗、表格等都有一些套路在那里,直接用就行了。

相关文章

  • kams前端代码规范

    1.由于各种原因,前端代码规范我是不准备写的,原因之一是我不准备以一个前端的要求去限制大家。但是,我还是看到了一些...

  • 代码规范

    代码规范 1. 概述 欢迎使用前端代码规范, 这里借鉴、引用的是京东前端代码规范。 遵循代码规范的目的在于增强团队...

  • 前端开发规范

    前端代码规范 Front Standard Guide 前端 JS 项目开发规范 规范的目的是为了编写高质量的代码...

  • 前端规范

    前端规范 规范说明 此为前端开发团队遵循和约定的代码书写规范,意在提高代码的规范性和可维护性。此规范为参考规范,统...

  • 代码规范

    代码规范 1. 概述 欢迎使用代码规范, 这个是我借鉴京东前端代码规范,组织的内部规范。旨在增强团队开发协作、提高...

  • 代码规范

    代码规范 作为前端工程化的第一步,就是要统一代码规范。而前端的代码规范,用三个插件就能保证(husky lint-...

  • 前端代码规范

    该文于 2013 年创作,经年修改,录以记之 统一的规范有助于团队合作开发,但规范又臭又长,又不利于阅读与遵守,所...

  • 前端代码规范

    命名规范 注释 eslint编码规范 使用两个空格进行缩进。eslint: indentfunction hell...

  • 前端代码规范

    一、前端编辑器 vscode 对angular、typescript有着非常友好的支持,轻便快捷,代码统一,一键格...

  • 前端代码规范

    一、格式化 1、代码缩进 4 个空格字符为一个缩进层级 2、语句结尾 每行语句结束必须使用分号结尾(“:”) 3、...

网友评论

    本文标题:kams前端代码规范

    本文链接:https://www.haomeiwen.com/subject/tqmqmttx.html