Loading [MathJax]/jax/output/CommonHTML/config.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场

规范

作者头像
wade
发布于 2020-04-24 03:26:12
发布于 2020-04-24 03:26:12
6530
举报
文章被收录于专栏:coding个人笔记coding个人笔记

Coding

规范

一个前端项目,目录的规范是必要的,当然,在一般开发中是没有必要做的那么严谨,在此,分享一下个人认为的基础规范,都只是个人认为。

项目目录规范

doc:使用的api,包括接口文档等,(个人认为这是个人习惯,有最好);

src:项目的代码源码,前端最核心内容css、js、html和静态资源图片;

README.md:一个好程序员应该有的文件。(本人还不够好,所以几乎没有)

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属性;

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2018-05-20,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 coding个人笔记 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
2400字整理Python编码规范,肝了一晚上~
对任何一门语言来说,学习编码规范都是第一要务,它制定了“游戏规则”,约束了我们的行动,我们只有在这个规则内编码才能被正确执行。想要写好Python代码,了解Python相关编码规范也是必要的。
程序员树先生
2023/02/22
9950
2400字整理Python编码规范,肝了一晚上~
【Python零基础到入门】Python预备知识必备篇——Python基本编码规范
如果是新手学习编写代码,那么在一开始就 熟记编码规则 对日后的编写规范是影响非巨大的!
呆呆敲代码的小Y
2021/11/10
9020
【Python零基础到入门】Python预备知识必备篇——Python基本编码规范
CSS编码规范
单行形式书写风格的排版约束 1.每一条规则的大括号 { 前后加空格 2.多个selector共用一个样式集,则多个selector必须写成多行形式 3.每一条规则结束的大括号 } 前加空格 4.属性名
HTML5学堂
2018/03/12
1.5K0
CSS编码规范
最新前端Vue代码风格指南大全
参照项目命名规则,有复数结构时,要采用复数命名法。例:docs、assets、components、directives、mixins、utils、views。
江一铭
2022/06/16
3.8K0
最新前端Vue代码风格指南大全
Web前端开发代码规范(基础)
对于一个多人团队来说,制定一个统一的规范是必要的,因为个性化的东西无法产生良好的聚合效果,规范化可以提高编码工作效率,使代码保持统一的风格,以便于代码整合和后期维护。
用户7705674
2021/09/19
2.2K0
通过分析Github众多前端代码库,总结出来的前端代码书写规范
永远一致同一套编码规范,可以是这里列出的,也可以是你自己总结的。如果您发现本规范中有任何错误,敬请在问题中指正。
用户5997198
2019/10/31
1.1K0
【开发规范系列】(四)前端开发规范
现代软件架构的复杂性需要协同开发完成,如何高效地协同呢?无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没有限速,没有红绿灯,谁还敢上路行驶。对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事,提升协作效率,降低沟通成本。代码的字里行间流淌的是软件系统的血液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升系统稳定性,码出质量。
程序员朱永胜
2023/09/01
8260
前端编码规范
[强制] class 必须单词全字母小写,单词间以 – 分隔。 [强制] class必须代表相应模块或部件的内容或功能,不得以样式信息进行命名。 [强制] 元素 id 必须保证页面唯一。 [强制] 同一页面,应避免使用相同的 name 和 id。 [建议] id 建议单词全字幕小写单词间以 – 分隔。同项目必须保持风格一致。 [建议] id、class命名,在避免冲突并描述清楚的前提下尽可能短。
玖柒的小窝
2021/11/08
1.7K0
JavaScript 代码规范
function toCelsius(fahrenheit) { return (5 / 9) * (fahrenheit - 32); }
陈不成i
2021/07/19
4400
JavaScript代码规范
统一团队的编码规范,有助于代码的维护。本章是传统意义上的 Style Guideline,目的是统一一些相对主观化的代码风格。
用户1065635
2019/03/21
2.7K1
谈谈编码与规范
既然是风格,就没有对错。就如现实生活中,我们每个人都有自己的穿着打扮一样。可能有些人打扮土一点,但土就土,并不影响什么。
一墨编程学习
2018/10/27
3870
2021最新阿里代码规范(前端篇)
正例:mall-management-system 反例:mall_management-system / mallManagementSystem
江一铭
2022/06/16
4.9K1
CSS 样式书写规范
可能不同团队都有各自的规范,又或者很多人在写 CSS 的时候还是想到什么就写什么,不存在太多的约束。 我觉得 CSS 代码规范还是有存在的必要的,尤其是在团队配合,多人协作下,规范就显得尤为重要。 本文的所列是实践当中得出的一套比较不错的 CSS 书写规范,并不希望大家完全采用,而是希望可以结合自己的团队需要,发展出一套适合自己的 CSS 代码规范。 也希望可以有更多的建议,共同的完善。本规范也可以在我的 Github 上看到,欢迎留言或者提 PR。 我觉得不同的规范都有各自的长处与缺陷,对待所谓的规范最
Sb_Coco
2018/05/28
1.3K0
【编码规范】Less 编码风格指南
@import 语句引用的文件必须(MUST)写在一对引号内,.less 后缀不得(MUST NOT)省略(与引入 CSS 文件时的路径格式一致)。引号使用 ' 和 " 均可,但在同一项目内必须(MUST)统一。
一尾流莺
2022/12/10
9840
前端培训二:前端代码规范
尽量遵循 HTML 标准和语义,但是不要以牺牲实用性为代价。任何时候都要尽量使用最少的标签并保持最小的复杂度。
Yuyy
2022/06/28
1.1K0
腾讯大佬的 Python 编码规范
Linux 平台上,一个 python 源码文件应该以下部分组成。Windows 平台上,可以省略第一项。
肉眼品世界
2020/11/17
1.6K0
前端代码规范
(1)用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法。
grain先森
2019/03/29
2.6K0
前端代码规范
软技能提升:转转中后台规范落地实践
中台覆盖了多线业务,自然对应的不少后台系统,考虑日后到项目应用,满足业务的快速迭代,无论是技术版本升级、敏捷开发、可复用性和可维护性等。
前端迷
2020/10/26
9250
软技能提升:转转中后台规范落地实践
NEC css规范
CSS规范 - 分类方法 SS文件的分类和引用顺序 通常,一个项目我们只引用一个CSS,但是对于较大的项目,我们需要把CSS文件进行分类。 我们按照CSS的性质和用途,将CSS文件分成“公共型样式”、“特殊型样式”、“皮肤型样式”,并以此顺序引用(按需求决定是否添加版本号)。 公共型样式:包括了以下几个部分:“标签的重置和设置默认值”、“统一调用背景图和清除浮动或其他需统一处理的长样式”、“网站通用布局”、“通用模块和其扩展”、“元件和其扩展”、“功能类样式”、“皮肤类样式”。 特殊型样式:当某个栏目或页面
用户1197315
2018/01/19
1.5K0
良好的CSS编码习惯
一个 css 文件的核心内容是由许许多多的 css 规则组成的,而每个规则又包含了两部分:选择器和声明;声明块里可能又包含多个声明,每个声明又是由属性和值组成的。这个大概就是 css 的代码结构。
用户4456933
2021/06/01
6330
良好的CSS编码习惯
相关推荐
2400字整理Python编码规范,肝了一晚上~
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档