您的当前位置:首页web前端项目规范

web前端项目规范

2020-10-07 来源:爱问旅游网
web前端项⽬规范

项⽬⽬录规范

.

├─ css

├─ component├─ img├─ js├─ page├─ test

├─ package.json├─ README.md

css

存放样式类⽂件,且所有 CSS ⽂件编写应当遵循

component

存放项⽬组件

img

存放项⽬的图⽚资源,应当按模块分⽂件夹存放

js

存放项⽬的 JS 源代码,且所有 JS ⽂件编写应当遵循

page

存放项⽬的 HTML 页⾯代码⽂件,且所有 HTML ⽂件编写应当遵循 备注:单页应⽤可以例外

test

所有测试相关⽂件应当放在此⽬录

package.json

每个项⽬都必须包含⼀个 package.json ⽂件,在使⽤ npm init 新建项⽬时⾃动⽣成,此⽂件中应当包含项⽬的基本信息、项⽬的依赖以及项⽬的相关执⾏命令等

README.md

每个项⽬都必须包含⼀个 README.md ⽂件,此⽂件中应当描述此项⽬的功能、特点、API 等信息

项⽬命名规范

⽂件及⽬录命名全部采⽤⼩写⽅式, 以下划线分隔⽬录有复数结构时,始终采⽤单数命名法

my_project_name/img/user_order.png

因篇幅问题不能全部显示,请点此查看更多更全内容