前端开发文档

本文介绍了前端开发的规范,包括目录构建、命名原则、BEM和OOCSS的CSS命名规范、JS的代码风格以及前端工作流程中的日报、周报和邮件规范。此外,还详细阐述了HTML、CSS和JS的编写标准,强调了代码可复用性和可维护性的重要性。
摘要由CSDN通过智能技术生成

1. 前端的开发规范

  1. 目录构建的规范
  • 命名原则:
  1. 简洁
    比如: src 源代码 img 图片资源 js JavaScript脚本 dep 第三方依赖包
  2. 不使用复数
    比如: 不使用 imgs docs
  • 根目录(root)结构按职能划分
    比如:
  1. src 源代码(逻辑)
  2. doc 文档
  3. dep 第三方依赖包
  4. test 测试
  • 根据业务逻辑进行文件夹的划分
    src
    common 公共资源
    img
    logo.png
    sprites.png
    css
    reset.css
    js

    conf.js 项目的配置文件
    public/static 静态资源
    js
    css
    tpl
    index.html
    shopcar.html
    img
    component 组件
    home
    shopcar
    login
    register
    user
    list
    detail

    view/tpl 项目模板 tpl 是 template的缩写
  • 总结:
    以上目录开发规范有两种使用途径
  1. 纯手动打造
  2. 快速构建工具做 —》 改造
    2. 前端命名规范
    BEM && OOCSS 针对的都是 css 命名规范
    jslint eslint js使用规范
    BEM规范
  3. 概念:
    Block Element Modifier,它是一种前端命名方法,旨在帮助开发者实现模块化、可复用、高可维护性和结构化的CSS代码。
  4. BEM是定义了一种css class的命名规范,每个名称及其组成部分都是存在一定的含义。
  5. 由拉丁字母, 数字, -组成css的单个名称.
    Block Element Modifier
    独立且有意义的实体, e.g. header, container, menu, checkbox, etc. Block的一部分且没有独立的意义, e.g. header title, menu item, list item, etc. Blocks或Elements的一种标志,可以用它改变其表现形式、行为、状态. e.g. disabled, checked, fixed, etc.
    Naming
    由拉丁字母, 数字, -组成css的单个名称.
    Block
    使用简洁的前缀名字来命名一个独立且有意义的抽象块或组件。
e.g.
.block
.header
.site-search
Element

使用__连接符来连接Block 和 Element。

e.g.
.block__element
.header__title
.site-search__field
Modifier

使用–连接符来连接Block 或 Element 和 Modifier。

e.g.
.block--mo
  • 3
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
web前端开发文档规范是指为了促进团队的工作效率和开发质量,以及方便后续维护和协作的需求,制定的一套文档编写与管理规范。以下是可以下载web前端开发文档规范的步骤和方法。 首先,可以通过互联网搜索相关的文档规范模板,如HTML、CSS、JavaScript等各种规范文档模板。可以在一些知名社区或技术论坛上找到一些优秀的前端开发文档规范模板,例如GitHub、博客园、掘金等。可以通过搜索引擎输入关键词,如“前端开发文档规范模板”来获取相关资源下载。 其次,一些知名的前端开发社区和网站也会提供完整的前端开发文档规范,并提供下载链接。例如MDN(Mozilla Developer Network)等网站提供了详细的HTML、CSS和JavaScript等的文档规范。这些规范是由专业的前端开发者和权威机构制定的,可以作为参考下载和学习。 另外,还可以通过加入一些前端开发相关的社群、群组和论坛,与其他前端开发者进行交流和分享。在这些社群中,一些经验丰富的前端开发者可能会分享他们自己制定的规范文档,这些文档更加贴近实际工作,具有很高的参考价值。可以与他们取得联系,互相交流和学习。 需要强调的是,无论下载哪种类型的前端开发文档规范,都要根据实际项目需求进行适当的调整和修改。每个项目都有自己的特点和需求,所以需要将规范文档与实际项目需求相结合,制定出符合实际情况的文档规范。通过下载和使用规范文档,能够提高前端开发的效率和质量,同时也方便日后的维护和协作工作。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值