首页 > 其他分享 >前端开发规范

前端开发规范

时间:2023-04-24 22:48:54浏览次数:44  
标签:函数 -- 规范 组件 HTML 命名 前端开发

什么是规范

规范就是一个大家都认同,都接受的一种模式.为什么要有这个规范呢,一是让自己的代码的可读性更高,别人一看就懂,二是也方便自己去回顾自己的代码.

提高开发的效率,使自己写出的代码不至于成为屎山.

规范的分类

  • HTML编码规范
  • 变量名命名规范
  • 文件夹命名规范
  • 组件命名规范
  • 编码格式规范

规范的实施

目前来说,存在着很多的规范,每个大厂的规范也不是一样的,比如阿里的规范,腾讯的规范,这时候应该怎么办呢,我们可以去采取一个折中的方法,集百家之长,成一家之言。

外部资源

阿里前端开发规范

前端html页面中的命名规范_wgaoxian的博客-CSDN博客

前端代码规范 及 最佳实践 | Isobar (coderlmn.github.io)

我常常烦恼的规范

  1. 文件夹命名
  2. 组件文件的命名
  3. 函数的命名
  4. HTML标签 class和id的命名

我的总结(简洁)

  • Vue组件文件的命名,组件名应该始终是多个单词组成(大于等于 2),且命名规范为 PascalCase(大驼峰) 格式,避免和 HTML 元素名称冲突。

Vue组件相关

命名

1、单例组件使用 The 前缀

2、非业务通用组件使用 Base 前缀

3、以两个单词组成的文件名时,应采用主次原则,如 TodoList,以高级别的 (通常是一般化描述的) 单词开头,以描述性的修饰词结尾。

模板中使用组件

说明:因为html对大小写不敏感, 所以在的template驼峰命名的都要写成短线分割形式,如

<component-vue></component-vue>

结构化

src                               源码目录
|-- api                              接口,统一管理
|-- assets                           静态资源,统一管理
|-- components                       公用组件,全局文件
|-- filters                          过滤器,全局工具
|-- icons                            图标,全局资源
|-- datas                            模拟数据,临时存放
|-- lib                              外部引用的插件存放及修改文件
|-- mock                             模拟接口,临时存放
|-- router                           路由,统一管理
|-- store                            vuex, 统一管理
|-- views                         视图目录
|   |-- staffWorkbench               视图模块名
|   |-- |-- staffWorkbench.vue       模块入口页面
|   |-- |-- indexComponents          模块页面级组件文件夹
|   |-- |-- components               模块通用组件文件夹

HTML语义化相关

HTML Semantic Elements

<article>
<aside>
<details>
<figcaption>
<figure>
<footer>
<header>
<main>
<mark>
<nav>
<section>
<summary>
<time>

函数的命名规则

函数是编程中非常重要的概念,良好的函数命名可以让代码清晰易懂,提高代码的可读性和可维护性。

1、函数的名称一般由 数字,字母,下划线 组成。

2、函数的命名要有意义,要做到顾名思义,尽可能描述函数的功能和用途。 例如,如果函数的作用是计算两个数字的和,那么函数名可以命名为“calculate_sum”或者“add_numbers”。

3、使用动词加名词的命名方式:函数名应该以一个动词开始,后面跟着一个名词或形容词,例如“get_value”、“calculate_average”。

4、使用清晰简洁的函数参数名:函数参数名应该能够清晰表达它们的含义,例如,如果函数需要接收一个字符串参数,那么可以将其命名为“string”。

业界编码风格习惯:

  1. 全小写,下划线(旧式C) go_to_school
  2. 每个单词首字母大写(C++)GoTOScool
  3. 第一个单词小写开头,后面的大写开头(JAVA、C#) goSchool

CSS 类和ID的命名

在查资料的时候看到了一句话觉得讲的非常的好,

这个类有什么作用,扮演了什么样的角色"(而不只是 "它看上去像是什么?"。)

例如红色的盒子:.red-box,只是看起来是红色的盒子,其实应该是 .color-box

标签:函数,--,规范,组件,HTML,命名,前端开发
From: https://www.cnblogs.com/yecss/p/17351208.html

相关文章

  • 1 Go语言介绍、 2 Go开发环境搭建 、3 第一个helloworld 、4 变量命名规范 、5 变量的
    目录1Go语言介绍2Go开发环境搭建3第一个helloworld4变量命名规范5变量的定义和使用1Go语言介绍#Go语言介绍Go即Golang,是Google公司2009年11月正式对外公开的一门编程语言Go是【静态强类型】语言,是区别于解析型语言的编译型语言(静态:类型固定强类型:不同类型不允许直接......
  • Go语言介绍、Go开发环境搭建、第一个helloworld、变量命名规范、变量的定义和使用
    目录1Go语言介绍2Go开发环境搭建3第一个helloworld4变量命名规范5变量的定义和使用1Go语言介绍#Go语言介绍Go即Golang,是Google公司2009年11月正式对外公开的一门编程语言Go是【静态强类型】语言,是区别于解析型语言的编译型语言(静态:类型固定强类型:不同类型不允许直接......
  • Markdown与中文文档写作规范
    记录一下Markdown学习,还有写作规范。Markdown学习Markdown语法教程写作规范中文技术文档的写作规范中文文案排版指北......
  • margin:auto position: absolute 居中 对应在 w3c规范 中的描述
    https://www.w3.org/TR/CSS2/visudet.html 10.6 CalculatingheightsandmarginsForcalculatingthevaluesof 'top', 'margin-top', 'height', 'margin-bottom',and 'bottom' adistinctionmustbemadebetween......
  • bootstrap css编码规范
    1.1. 语法1.        用两个空格来代替制表符(tab)--这是唯一能保证在所有环境下获得一致展现的方法。2.        为选择器分组时,将单独的选择器单独放在一行。3.        为了代码的易读性,在每个声明块的左花括号前添加一个空格。4.        声明块......
  • Java编码规范-字符串与Integer的比较,BigDecimal非空参数
    Java编码规范-字符串与Integer的比较,BigDecimal非空参数packagecom.example.core.mydemo;importjava.math.BigDecimal;publicclassIntTest{publicstaticvoidmain(String[]args){Integertype=2;//if("2".equals(type)){if(typ......
  • 学系统集成项目管理工程师(中项)系列03_职业道德规范
    1. 职业道德1.1. 涵盖了从业人员与服务对象、职业与职工、职业与职业之间的关系1.2. 是所有从业人员在职业活动中应该遵循的行为准则1.3. 包括爱岗敬业、诚实守信、办事公道、服务群众和奉献社会2. 道德2.1. 通常与法律相对应,具有非强制性2.2. 指人们依靠社会舆论、......
  • 前后端分离之接口设计规范
    如何做分离 职责分离前后端仅仅通过异步接口来编程前后端都各自有自己的开发流程,构建工具,测试集合关注点分离,前后端变得相对独立并松耦合开发流程后端编写和维护接口文档,在API变化时更新接口文档后端根据接口文档进行接口开发前端根据接口文档进行开发+Mock......
  • redis的key命名规范
    一、键值设计1.key名设计【建议】:可读性和可管理性以业务名(或数据库名)为前缀(防止key冲突),用冒号分隔,比如业务名:表名:idredis使用的时候注意命名空间,一个项目一个命名空间,项目内业务不同命名空间也不同。一般情况下:1)第一段放置项目名或缩写如project2)第二段把表名......
  • vue兼容IE的方法规范
    第三方插件的兼容性需经过ie和国产电脑浏览器测试后,才可以使用。1、main.js顶部添加babel-polyfillimport'babel-polyfill'importVuefrom'vue'importAppfrom'./App.vue'importrouterfrom'./router'importstorefrom'./store'2、js-base6......