美文网首页Web前端之路
项目根目录结构及代码规范

项目根目录结构及代码规范

作者: consolelog | 来源:发表于2019-08-05 12:51 被阅读4次

文件夹规范

  1. 根据项目名创建项目文件夹。
  2. 在项目文件夹创建html、css、img、js四个文件夹存放相应文档。
  3. 文件命名时应该全部使用英文命名,尽量语义化。媒体文件命名时尽量与模块名称有关联(如login_bg.jpg、login_user_ico.gif等)。

HTML 书写规范

  1. 书写规范:
    书写时根据页面结构实现层次分明的缩进;
    标签属性名由数字、小写字母、下划线组成,且所有标签必须闭合;
  2. 语义化HTML:
    在布局是尽量用html5中的一些新的语义化标签,标题h1只能出现一次、段落用p、行级元素不能嵌套块级元素等。
  3. 尽量保证结构样式分离。
  4. 尽量控制元素嵌套的层级不合理的嵌套可能会影响页面性能。
  5. HTML中的图片
    img标签添加 alt="" 替换文本,以防图片丢失;
    在保证视觉效果的情况下尽量选择比较小的图片,以减少加载时间;
    使用精灵图标技术减少页面的HTTP请求。

css书写规范

  1. 指定编码集,统一为UFT-8。

  2. 书写代码前

  • 考虑样式规划,提高样式重复使用率。
  • 确定版心,合理布局。
  1. 书写代码时
  • 适当的添加注释。
  • 保持代码缩进,建议单行书写。
  1. class与id的命名
  • 全小写命名,中间用 - 连接;驼峰法命名。
  • 命名简洁、明了、语义化。
  • css书写顺序:
    尽量遵循:布局定位属性 -> 自身属性 -> 文本属性 -> 其他属性。
  1. css样式表文件命名
  • index.css(首页的)

  • master.css (主要的)

  • layout.css (布局、版面)

  • themes.css(主题)

  • columns.css(专栏)

  • font.css (文字)

  • forms.css(表单)

  • base.css、public.css、common.css(基本公用,以下为一些常用的公共文件)

* {
    padding:0;
    margin:0;
    box-sizing:border-box;
}

 a {
   text-docoration:none;
}

.clear-fix:after {    /*清除浮动的影响*/
    content:"";
    display:block;
    clear:both;
    height:0;
    line-height:0;
    visiblility:hidden;
}

给网站添加标题、关键字,描述

  1. 为网页添加标题
    <title>网页标题</title>
  2. 为搜索引擎定义关键字
    <meta name="keywords" content="HTML,CSS,JavaScript">
    搜索引擎在遇到这些关键字时,会用这些关键字对文档分类。
  3. 为网页定义描述内容
    <meta name="description" content="web 前端开发、网页制">
  4. 网页标题栏图标
    <link href="favicon.ico rel="icon"/>

相关文章

  • 项目根目录结构及代码规范

    文件夹规范 根据项目名创建项目文件夹。 在项目文件夹创建html、css、img、js四个文件夹存放相应文档。 文...

  • swift代码开发规范

    目录 工程结构 模块代码结构 代码书写规范 一、工程结构 当前swift项目工程还在整合中,这里以旧项目结构进行展...

  • 项目结构及规范

    vue A Vue.js project Build Setup For a detailed explanati...

  • Android开发规范

    目录 项目结构 代码结构 命名规范 ● 方法 ● 变量 ● 类 ● 文件 ● 常量 注释 项目结构 由于公司有两个...

  • iOS OC编码规范指南

    说明:规范的目的是提高效率,所使用的规范应该是适应当前团队的。 项目工程结构 代码结构 实现文件中的代码结构,提倡...

  • iOS小组代码分支管理

    代码分支管理规范 为了规范代码库分支管理和版本管理,使代码分支及版本结构清晰,方便维护,并避免由于维护造成的错误的...

  • git 分支规范

    git分支规范 目的 为了规范代码库分支管理 和 版本管理,使代码分支及版本结构清晰, 方便维护,并避免由于维护造...

  • golang源码生成docker镜像

    使用gin创建一个简单的api服务,代码如下: 同时在项目根目录创建Dockerfile文件 项目结构如下: 使用...

  • 前端编码规范

    Vue项目规范 项目工程化,工程化的项目结构拥有多方面的好处,下文链接有详细的说明。 说明: CSS代码规范 1、...

  • VUE项目规范

    一简介 此规范基于脚手架vue-cli3.+ 从编写IDE,到项目结构,命名规范,代码风格,包括代码逻辑等,都做了...

网友评论

    本文标题:项目根目录结构及代码规范

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