一个前端项目,目录的规范是必要的,当然,在一般开发中是没有必要做的那么严谨,在此,分享一下个人认为的基础规范,都只是个人认为。
doc:使用的api,包括接口文档等,(个人认为这是个人习惯,有最好);src:项目的代码源码,前端最核心内容css、js、html和静态资源图片;
:一个好程序员应该有的文件。(本人还不够好,所以几乎没有)
JavaScript规范 JS的规范就很多了,各个大公司的规范也不尽相同,由于水平有限,在我的理解就是,一个项目的规范主要就是约定好代码的风格。在此罗列一些基础的JavaScript代码规范: 缩进:统一缩进,一个项目要码四个空格一个tab,要码两个空格一个tab;
空格:二元运算符左右空格,一元运算符不允许有空格,var a = b; a++;!a;冒号之后有空格var obj = {a: 1};逗号之后又空格function(a, b, c){};
分号:函数定义结束不加分号,其他都加分号function(){} for(){};
命名:都已驼峰法命名(有人建议常量都大写然后下划线隔开,类首字母大写)
注释:注释规范有单行、多行、文件注释、命名空间注释等等等等,水平有限,还未实践,可自行百度;
字符串:因为JS的特性,建议都用单引号 var str = 'aaa';
JavaScript规范的东西太多,还有面向对象、动态特性、浏览器环境、模块化、函数、数组等等等,在此只列举一些个人认为最基础的;
CSS规范 缩进:统一四个空格或两个空格作为缩进;
空格:属性名冒号之后空格,margin: 0;列表属性值逗号之后空格,font-family: Arial, Aharoni;
命名:全小写,-隔开,.main-title;
选择器:多个选择器声明同一样式时,每个选择器各占一行
.post, .page{} > + 等选择器两边加空格 nav > div{}复制代码
引号:有些样式需要引号的,只能用双引号;
层级:不建议超过4级;
缩写:尽可能的使用缩写rgba(0, 0, 0, .3);
顺序:css属性编写是有一套顺序的,比如位置大于尺寸等,本人没做到所以请自行百度;
谨慎使用:!important z-index 定位;
数值:小于1的小数,可省略0,opacity: .4,为0的就不要单位 margin: 0;
背景图:直接使用url(test.png);
颜色:统一使用十六进制,大小写约定统一,可缩写就缩写;
HTML规范 缩进:统一四个空格或两个空格作为缩进;
符合嵌套规则:比如div不能放在span中 ul li配套使用;
引入:css必须要有rel,放在heaa,JavaScript无需声明type,放在页面末尾,
favicon:保证可以访问;
img:增加alt属性;
欢迎关注 Coding 个人笔记 公众号