文档章节

前端开发规范,简单的处理项目规范

misterChangRay
 misterChangRay
发布于 2017/04/23 17:49
字数 983
阅读 8
收藏 0
点赞 0
评论 0

前往查看原文

文件规范:
  1. 文件命名全小写
  2. 多个单词之间使用中横线连接
  3. 文件编码统一使用UTF8
  4. 文件头必须要有注释,标明文件用途、作者、版本等信息
css命名规范:
  1. 类名全部为小写
  2. 类名多个单词之间使用中横线连接
js语法规范:
  1. 变量名/函数名统一使用小驼峰命名,可以为拼音或英文但不可混合使用,拼音应用全拼;
  2. 构造函数或类的声明应使用大驼峰命名;
  3. 请尽量语义化变量名/属性名/自定义标签名;
  4. 变量或函数应有其适当注释, 拒绝无注释代码, 并提高函数重用率;
  5. 无特别情况每行代码应尽量保持在100字符以内, 代码应有必要的缩进;
  6. 花括号和关键词应位于一行,不应另起一行,如:
   function user() {   //这里和function关键词位于一行
      ...
   };

   if(flag) {    //这里和if关键词同行
      ...
   };
  1. 请使用var 来声明变量,且在连续声明变量时注意加上空格, 如: var user, name; //在user, 和 name 之间保持一个空格;
  2. 私有变量以下划线打头如:var _classVarName;
  3. 常量应全为大写;
  4. 规范定义json对象, key 和 value 都加上双引号, 如: {“name”:”jackson”};
  5. 方法与方法之间应有一个空行;
  6. 提交代码前应先拉取代码,另外代码提交应写好1-50字的描述;
  7. 请注意语句结束或文件开头必须加上”;”号;
  8. 函数应该是统一的返回类型, 即:一个函数中不能有多个不同的数据类型返回;
  9. 函数命名应为动词+名词形式,部分常用命名参考常用固定命名;
  10. 字符串统一使用’单引号’, 且不要在非赋值的地方出现中文;
  11. 原则上可采用任意开发工具但不可如下使用:

使用IDE的视图模式”画”代码; 使用IDE的部分功能生成相关功能代码;

参考文档
  1. Web Styleguide
  2. Web前端开发规范文档
  3. 前端开发规范文档
附录 - 常用固定命名(XXXX可替换为名词)

固定命名 解释 示例/注释
initXXXX 初始化
queryXXXX 查询
getXXXX 获取
updateXXXX 更新
deleteXXXX 删除
saveXXXX 保存
importXXXX 引入
exportXXXX 导出
refreshXXXX 刷新 startXXXX 开始 encodeXXXX 编码 decodeXXXX 解码 restoreXXXX 恢复 resetXXXX 重置 resetForm/重置表单 sendXXXX 发送 calcXXXX 计算 常用动词参考 query 查询/update 更新/delete 删除 get 获取/set 设置/add 增加/remove 删除/create 创建/destory 移除 start 启动/stop 停止/open 打开/close 关闭/read 读取/write 写入 load 载入/save 保存/create 创建/destroy 销毁 begin 开始/end 结束/backup 备份/restore 恢复/detach 脱离 import 导入/export 导出/split 分割/merge 合并/inject 注入/extract 提取 attach 附着/bind 绑定/separate 分离/ view 查看/browse 浏览 edit 编辑/modify 修改/select 选取/mark 标记/copy 复制/paste 粘贴/undo 撤销 redo 重做/insert 插入/delete 移除/add 加入/append 添加 clean 清理/clear 清除/index 索引/sort 排序/find 查找/search 搜索/ increase 增加/decrease 减少/play 播放/pause 暂停/ launch 启动/run 运行/pack 打包/unpack 解包/parse 解析/emit 生成 compile 编译/execute 执行/debug 调试/trace 跟踪 observe 观察/listen 监听/build 构建/publish 发布/push 推/pull 拉 input 输入/output 输出/encode 编码/decode 解码 expand 展开/collapse 折叠/encrypt 加密/decrypt 解密 compress 压缩/decompress 解压缩 connect 连接/disconnect 断开/send 发送/receive 接收 download 下载/upload 上传/refresh 刷新/synchronize 同步 update 更新/revert 复原/lock 锁定/unlock 解锁 check out 签出/check in 签入/submit 提交/commit 交付 begin 起始/end 结束/start 开始/finish 完成/enter 进入/exit 退出 abort 放弃/quit 离开/obsolete 废弃/depreciate 废旧 collect 收集/aggregate 聚集

© 著作权归作者所有

共有 人打赏支持
misterChangRay
粉丝 1
博文 3
码字总数 7007
作品 1
成都
程序员
前端协作流程

Web系统   在介绍协作流程之前,首先简单地了解Web系统的结构   从宏观上来说,Web系统是部署在服务器上用于为web客户端提供服务的系统。不同的Web客户端根据不同的需求,发送请求到服务...

sshpp ⋅ 2017/07/24 ⋅ 0

前端工程化——构建工具选型

注:文章源于2017年8月的一次内部分享,部分数据可能已经过时。 一、什么是前端工程化 前端工程化是依据业务特点,将前端开发的规范、流程、技术、工具、经验等形成规范并建立成一种标准的体...

Bellhe ⋅ 01/08 ⋅ 0

小结(工作 + 生活)

今天早上出门去医院挂号,走到地铁忘记带钱,又折返回去拿钱包,挂好号了,走的时候却忘记把市民卡给双凤。一系列的不走心事情搞得我想死的心都有了。 想看些技术博客,看一页就没有耐心往下...

-波仔- ⋅ 2016/08/02 ⋅ 0

java web全栈漫谈

一个项目从需求确认到上线,生命周期其实还是挺长的。作为一般公司的话,分工是比较具体的,比如从需求分析师,产品经理,美工,前端,后端再到运维,每个工种都有,但如果要全栈的话,还是要...

tomzhao ⋅ 2016/10/16 ⋅ 2

Gulp、Webpack区别

在现在的前端开发中,前后端分离、模块化开发、版本控制、文件合并与压缩、mock数据等等一些原本后端的思想开始逐渐渗透到“大前端”的开发中。前端开发过程越来越繁琐,当今越来越多的网站已...

追风_ ⋅ 01/02 ⋅ 0

前端接口设计

概述   在协作流程的博文中,我们了解了一个Web系统的体系架构,以及前端与后端交互的整个流程,接下来简单回顾,并进行相应的规则约定   当客户端向服务器端发送一个请求时,服务器端的...

sshpp ⋅ 2017/07/24 ⋅ 0

你不知道的h5

基于 Three.js 的超快的 3D 开发框架:Whitestorm.js Whitestorm.js 是一款基于 Three.js 超快的 Web 应用 3D 开发框架。它为普通的 Three.js 任务提供封装、使搭建环境、创建对象、添加物件...

掘金官方 ⋅ 2017/12/07 ⋅ 0

从开发框架提高开发效率说起

在我们接触的很多项目中,如果有一些参考性的项目框架,那么做起开发来,事半功倍,一般来说搭建或者积累这些框架性的项目,非一日之功。一般我们可以把具体的项目分为Winfrom、Web、微信、或...

walb呀 ⋅ 2017/12/04 ⋅ 0

web人力资源信息系统开发日志④

第四阶段(2017年6月21—7月6日):进入测试冲刺阶段,bug大扫荡,总结分析并准备上线交付使用。软件的生命周期就是不断更新升级,一旦停止更新,软件生命就会衰老枯竭。接下来的工作是调试上...

人可工作室 ⋅ 2017/07/09 ⋅ 0

正在创业或准备创业的你如何组建技术团队?

深夜,一个人独自在公司听着音乐看着文章的标题在发呆,一个从来没有写过文章的我不知道怎么把文章写得更简单明了让大家看了所有收获及原意看完,很多人会有疑问,都不知道怎么写为什么要写呢...

程序员客栈 ⋅ 2016/05/23 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

OSChina 周三乱弹 —— 这样的女人私生活太混乱了

Osc乱弹歌单(2018)请戳(这里) 【今日歌曲】 @ 胖达panda :你经历过体验到人生的大起大落吗?我一朋友在10秒内体验了,哈哈。@小小编辑 请点一首《almost lover》送给他。 《almost love...

小小编辑 ⋅ 24分钟前 ⋅ 5

自己动手写一个单链表

文章有不当之处,欢迎指正,如果喜欢微信阅读,你也可以关注我的微信公众号:好好学java,获取优质学习资源。 一、概述 单向链表(单链表)是链表的一种,其特点是链表的链接方向是单向的,对...

公众号_好好学java ⋅ 30分钟前 ⋅ 0

Centos7重置Mysql 8.0.1 root 密码

问题产生背景: 安装完 最新版的 mysql8.0.1后忘记了密码,向重置root密码;找了网上好多资料都不尽相同,根据自己的问题总结如下: 第一步:修改配置文件免密码登录mysql vim /etc/my.cnf 1...

豆花饭烧土豆 ⋅ 今天 ⋅ 0

熊掌号收录比例对于网站原创数据排名的影响[图]

从去年下半年开始,我在写博客了,因为我觉得业余写写博客也还是很不错的,但是从2017年下半年开始,百度已经推出了原创保护功能和熊掌号平台,为此,我也提交了不少以前的老数据,而这些历史...

原创小博客 ⋅ 今天 ⋅ 0

LVM讲解、磁盘故障小案例

LVM LVM就是动态卷管理,可以将多个硬盘和硬盘分区做成一个逻辑卷,并把这个逻辑卷作为一个整体来统一管理,动态对分区进行扩缩空间大小,安全快捷方便管理。 1.新建分区,更改类型为8e 即L...

蛋黄Yolks ⋅ 今天 ⋅ 0

Hadoop Yarn调度器的选择和使用

一、引言 Yarn在Hadoop的生态系统中担任了资源管理和任务调度的角色。在讨论其构造器之前先简单了解一下Yarn的架构。 上图是Yarn的基本架构,其中ResourceManager是整个架构的核心组件,它负...

p柯西 ⋅ 今天 ⋅ 0

uWSGI + Django @ Ubuntu

创建 Django App Project 创建后, 可以看到路径下有一个wsgi.py的问题 uWSGI运行 直接命令行运行 利用如下命令, 可直接访问 uwsgi --http :8080 --wsgi-file dj/wsgi.py 配置文件 & 运行 [u...

袁祾 ⋅ 今天 ⋅ 0

JVM堆的理解

在JVM中,我们经常提到的就是堆了,堆确实很重要,其实,除了堆之外,还有几个重要的模块,看下图: 大 多数情况下,我们并不需要关心JVM的底层,但是如果了解它的话,对于我们系统调优是非常...

不羁之后 ⋅ 昨天 ⋅ 0

推荐:并发情况下:Java HashMap 形成死循环的原因

在淘宝内网里看到同事发了贴说了一个CPU被100%的线上故障,并且这个事发生了很多次,原因是在Java语言在并发情况下使用HashMap造成Race Condition,从而导致死循环。这个事情我4、5年前也经历...

码代码的小司机 ⋅ 昨天 ⋅ 2

聊聊spring cloud gateway的RetryGatewayFilter

序 本文主要研究一下spring cloud gateway的RetryGatewayFilter GatewayAutoConfiguration spring-cloud-gateway-core-2.0.0.RC2-sources.jar!/org/springframework/cloud/gateway/config/G......

go4it ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部