开发规范

网站开发规范

GitHub仓库：https://github.com/lancomeProject/LANCOME_project.git

代码规范vscode插件：eslint、prettier 安装

一、项目命名

• 全部采用小写方式， 以下划线分隔。
  • 例：my_project_name

二、目录命名

• 完整英文命名的用复数形式，缩写用单数形式
  • 完整英文：scripts,styles,images,modules(data_models,lego_modules,…)…
  • 缩写：js,css,img,pages…
• 咱们采用完整英文(复数形式)的目录命名方式
  • JS 文件命名模型：某某页面_model.js
    • 例:account_model.js
  • CSS 文件命名：某某页面_model.css
  • HTML 文件命名：某某页面_model.html

目录模板！！！

• my_lancome_project 文件名
  • index.html 主页 html 文件
  • index.css 主页 css 文件
  • index.js 主页 js 文件
  • scripts/ js 文件目录
    • scripts/components/: jQuery、Bootstrap 插件的 js 文件
    • scripts/ajax/： ajax 的封装
    • scripts/utils/： 公用方法的封装
    • scripts/pages/： 每个页面的 js 文件
      • 每个人的 js 独立起语义化名字（不会英文翻译一下）
  • data/: json 本地数据文件
    • 每个页面的 json 数据自己抠下来， 先弄成自己的， 最后再合并
  • styles/： 样式文件目录
  • images/： 图片文件目录
  • pages/： 每个页面

三、其他规则

1、分号

• 以下几种情况后需加分号：
  • 变量声明
  • 表达式
  • return
  • throw
  • break
  • continue
  • do-while

2、变量命名

• 标准变量采用驼峰式命名
• 构造函数，大写第一个字母
• jquery 对象必须以’$’开头命名

3、变量声明

• var 的数量不做限制，但要统一，一行定义一个变量。
• 尽量把需要声明的变量都写在前边

4、undefined

• 永远不要直接使用 undefined 进行变量判断；
• 使用 typeof 和字符串’undefined’对变量进行判断。

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