CRMEB 代码规范指南:ThinkPHP6+Uni-app 架构下的开发标准

二、代码规范

2.1 Vue

.1.1 代码结构
<template><div id="my-component"><DemoComponent /></div>
</template><script>
import DemoComponent from '../components/DemoComponent'export default {name: 'MyComponent',components: {DemoComponent},mixins: [],props: {},data () {return {}},computed: {},watch: {}created () {},mounted () {},destroyed () {},methods: {},
}
</script><style lang="scss" scoped>
#my-component {
}
</style>
2.1.2 data

组件的 **data** 必须是一个函数。

// In a .vue file
export default {data () {return {foo: 'bar'}}
}
2.1.3 props

props 定义应该尽量详细。

export default {props: {status: {type: String,required: true,validator: function (value) {return ['syncing', 'synced','version-conflict','error'].indexOf(value) !== -1}}}
}
2.1.4 computed

应该把复杂计算属性分割为尽可能多的更简单的属性。  小的、专注的计算属性减少了信息使用时的假设性限制,所以需求变更时也用不着那么多重构了。

// bad
computed: { price: function () { var basePrice = this.manufactureCost / (1 - this.profitMargin) return ( basePrice - basePrice * (this.discountPercent || 0) ) } 
}// good
computed: {basePrice: function () {return this.manufactureCost / (1 - this.profitMargin)},discount: function () {return this.basePrice * (this.discountPercent || 0)},finalPrice: function () {return this.basePrice - this.discount}
}
2.1.5 为 v-for 设置键值

在组件上必须用 **key** 搭配 **v-for**,以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为,比如动画中的对象固化 (object constancy)。

<ul><liv-for="todo in todos":key="todo.id">{{ todo.text }}</li>
</ul>
2.1.6 v-if 和 v-for 互斥

永远不要把 **v-if** **v-for** 同时用在同一个元素上。

<!-- bad:控制台报错 -->
<ul><liv-for="user in users"v-if="shouldShowUsers":key="user.id">{{ user.name }}</li>
</ul>

一般我们在两种常见的情况下会倾向于这样做:

  • 为了过滤一个列表中的项目 (比如 v-for="user in users" v-if="user.isActive")。在这种情形下,请将 users 替换为一个计算属性 (比如 activeUsers),让其返回过滤后的列表。
computed: {activeUsers: function () {return this.users.filter((user) => {return user.isActive})}
}
<ul><liv-for="user in activeUsers":key="user.id">{{ user.name }}</li>
</ul>
  • 为了避免渲染本应该被隐藏的列表 (比如 v-for="user in users" v-if="shouldShowUsers")。这种情形下,请将 v-if 移动至容器元素上 (比如 ulol)。
<!-- bad -->
<ul><liv-for="user in users"v-if="shouldShowUsers":key="user.id">{{ user.name }}</li>
</ul><!-- good -->
<ul v-if="shouldShowUsers"><liv-for="user in users":key="user.id">{{ user.name }}</li>
</ul>
2.1.7 多个 attribute 的元素

多个 attribute 的元素应该分多行撰写,每个属性一行。

<!-- bad -->
<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">
<MyComponent foo="a" bar="b" baz="c"/>
<!-- good -->
<imgsrc="https://vuejs.org/images/logo.png"alt="Vue Logo"><MyComponentfoo="a"bar="b"baz="c"/>
2.1.8 模板中简单的表达式

组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性或方法。

复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么,而非如何计算那个值。而且计算属性和方法使得代码可以重用。

// bad
{{fullName.split(' ').map((word) => {return word[0].toUpperCase() + word.slice(1)}).join(' ')
}}

更好的做法:

<!-- 在模板中 -->
{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {normalizedFullName: function () {return this.fullName.split(' ').map(function (word) {return word[0].toUpperCase() + word.slice(1)}).join(' ')}
}
2.1.9 带引号的 attribute 值

非空 HTML 特性值应该始终带双引号。

<!-- bad -->
<input type=text>
<AppSidebar :style={width:sidebarWidth+'px'}>
<!-- good -->
<input type="text">
<AppSidebar :style="{ width: sidebarWidth + 'px' }">
2.1.10 指令缩写
  • **:** 表示 **v-bind:**
  • **@** 表示 **v-on:**
  • **#** 表示 **v-slot:**
<input:value="newTodoText":placeholder="newTodoInstructions"><input@input="onInput"@focus="onFocus"><template #header><h1>Here might be a page title</h1>
</template><template #footer><p>Here's some contact info</p>
</template>

2.2 HTML

2.2.1 文件模板

HTML5 文件模板:

<!DOCTYPE html><html lang="zh-CN"><head><meta charset="UTF-8"><title>HTML5标准模版</title></head><body></body>
</html>

移动端:

<!DOCTYPE html>
<html lang="zh-CN">
<head><meta charset="UTF-8"><meta name="viewport"content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, shrink-to-fit=no"><meta name="format-detection" content="telephone=no"><title>移动端HTML模版</title><!-- S DNS预解析 --><link rel="dns-prefetch" href=""><!-- E DNS预解析 --><!-- S 线上样式页面片,开发请直接取消注释引用 --><!-- #include virtual="" --><!-- E 线上样式页面片 --><!-- S 本地调试,根据开发模式选择调试方式,请开发删除 --><link rel="stylesheet" href="css/index.css"><!-- /本地调试方式 --><link rel="stylesheet" href="http://srcPath/index.css"><!-- /开发机调试方式 --><!-- E 本地调试 --></head>
<body>
</body>
</html>

PC 端:

<!DOCTYPE html>
<html lang="zh-CN">
<head><meta charset="UTF-8"><meta name="keywords" content="your keywords"><meta name="description" content="your description"><meta name="author" content="author,email address"><meta name="robots" content="index,follow"><meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1"><meta name="renderer" content="ie-stand"><title>PC端HTML模版</title><!-- S DNS预解析 --><link rel="dns-prefetch" href=""><!-- E DNS预解析 --><!-- S 线上样式页面片,开发请直接取消注释引用 --><!-- #include virtual="" --><!-- E 线上样式页面片 --><!-- S 本地调试,根据开发模式选择调试方式,请开发删除 --><link rel="stylesheet" href="css/index.css"><!-- /本地调试方式 --><link rel="stylesheet" href="http://srcPath/index.css"><!-- /开发机调试方式 --><!-- E 本地调试 -->
</head>
<body>
</body>
</html>
2.2.2 元素及标签闭合

HTML 元素共有以下5种:

  • 空元素:area、base、br、col、command、embed、hr、img、input、keygen、link、meta、param、source、track、wbr
  • 原始文本元素:script、style
  • RCDATA 元素:textarea、title
  • 外来元素:来自 MathML 命名空间和 SVG 命名空间的元素
  • 常规元素:其他 HTML 允许的元素都称为常规元素

为了能让浏览器更好的解析代码以及能让代码具有更好的可读性,有如下约定:

  • 所有具有开始标签和结束标签的元素都要写上起止标签,某些允许省略开始标签或和束标签的元素亦都要写上。
  • 空元素标签都不加 “/” 字符。
<!-- good -->
<div><h1>我是h1标题</h1><p>我是一段文字,我有始有终,浏览器能正确解析</p>
</div><br data-tomark-pass><!-- bad -->
<div><h1>我是h1标题</h1><p>我是一段文字,我有始无终,浏览器亦能正确解析
</div><br/>
2.2.3 代码嵌套

元素嵌套规范,每个块状元素独立一行,内联元素可选。

<!-- good -->
<div><h1></h1><p></p>
</div>    
<p><span></span><span></span></p><!-- bad -->
<div><h1></h1><p></p>
</div>    
<p> <span></span><span></span>
</p>

段落元素与标题元素只能嵌套内联元素。

<!-- good -->
<h1><span></span></h1>
<p><span></span><span></span></p><!-- bad -->
<h1><div></div></h1>
<p><div></div><div></div></p>

2.3 CSS

2.3.1 样式文件

样式文件必须写上 @charset 规则,并且一定要在样式文件的第一行首个字符位置开始写,编码名用 “UTF-8”

  • 推荐:
@charset "UTF-8";
.jdc {}
  • 不推荐:
/* @charset规则不在文件首行首个字符开始 */
@charset "UTF-8";
.jdc {}/* @charset规则没有用小写 */
@CHARSET "UTF-8";
.jdc {}/* 无@charset规则 */
.jdc {}
2.3.2 代码格式化

样式书写一般有两种:一种是紧凑格式 (Compact),一种是展开格式(Expanded)。

  • 推荐:展开格式(Expanded)
.jdc {display: block;width: 50px;
}
  • 不推荐:紧凑格式 (Compact)
.jdc { display: block; width: 50px;}
2.3.3 代码大小写

样式选择器,属性名,属性值关键字全部使用小写字母书写,属性字符串允许使用大小写。

  • 推荐:
.jdc {display: block;
}
  • 不推荐:
.JDC {DISPLAY: BLOCK;
}
2.3.4 代码易读性
  1. 左括号与类名之间一个空格,冒号与属性值之间一个空格。
  • 推荐:
.jdc {width: 100%;
}
  • 不推荐:
.jdc{width:100%;
}
  1. 逗号分隔的取值,逗号之后一个空格。
  • 推荐:
.jdc {box-shadow: 1px 1px 1px #333, 2px 2px 2px #ccc;
}
  • 不推荐:
.jdc {box-shadow: 1px 1px 1px #333,2px 2px 2px #ccc;
}
  1. 为单个 CSS 选择器或新声明开启新行。
  • 推荐:
.jdc, .jdc_logo, .jdc_hd {color: #ff0;
}.nav{color: #fff;
}
  • 不推荐:
.jdc, .jdc_logo, .jdc_hd {color: #ff0;
}.nav{color: #fff;
}
  1. 颜色值 rgb() rgba() hsl() hsla() rect() 中不需有空格,且取值不要带有不必要的 0。
  • 推荐:
.jdc {color: rgba(255,255,255,.5);
}
  • 不推荐:
.jdc {color: rgba( 255, 255, 255, 0.5 );
}
  1. 属性值十六进制数值能用简写的尽量用简写。
  • 推荐:
.jdc {color: #fff;
}
  • 不推荐:
.jdc {color: #ffffff;
}
  1. 不要为 0 指明单位。
  • 推荐:
.jdc {margin: 0 10px;
}
  • 不推荐:
.jdc {margin: 0px 10px;
}
2.3.5 属性值引号

CSS 属性值需要用到引号时,统一使用单引号。

  • 推荐:
.jdc {font-family: 'Hiragino Sans GB';
}
  • 不推荐:
.jdc {font-family: "Hiragino Sans GB";
}

####2.3.6 属性书写建议

建议遵循以下顺序:

  1. 布局定位属性:display / position / float / clear / visibility / overflow
  2. 自身属性:width / height / margin / padding / border / background
  3. 文本属性:color / font / text-decoration / text-align / vertical-align / white- space / break-word
  4. 其他属性(CSS3):content / cursor / border-radius / box-shadow / text-shadow / background: linear-gradient …
.jdc {display: block;position: relative;float: left;width: 100px;height: 100px;margin: 0 10px;padding: 20px 0;font-family: Arial, 'Helvetica Neue', Helvetica, sans-serif;color: #333;background: rgba(0,0,0,.5);-webkit-border-radius: 10px;-moz-border-radius: 10px;-o-border-radius: 10px;-ms-border-radius: 10px;border-radius: 10px;
}
3.3.7 CSS3 浏览器私有前缀

CSS3 浏览器私有前缀在前,标准前缀在后。

.jdc {-webkit-border-radius: 10px;-moz-border-radius: 10px;-o-border-radius: 10px;-ms-border-radius: 10px;border-radius: 10px;
}

2.4 JavaScript

2.4.1 单行代码块

在单行代码块中使用空格。

  • 不推荐:
function foo () {return true}
if (foo) {bar = 0}
  • 推荐:
function foo () { return true }
if (foo) { bar = 0 }
2.4.2 大括号风格

在编程过程中,大括号风格与缩进风格紧密联系,用来描述大括号相对代码块位置的方法有很多。在 JavaScript 中,主要有三种风格,如下:

  • 【推荐】One True Brace Style
if (foo) {bar()
} else {baz()
}
  • Stroustrup
if (foo) {bar()
}
else {baz()
}
  • Allman
if (foo)
{bar()
}
else
{baz()
}
2.4.3 代码中的空格
  1. 逗号前后的空格可以提高代码的可读性,团队约定在逗号后面使用空格,逗号前面不加空格。
  • 推荐:
var foo = 1, bar = 2
  • 不推荐:
var foo = 1,bar = 2var foo = 1 , bar = 2var foo = 1 ,bar = 2
  1. 对象字面量的键和值之间不能存在空格,且要求对象字面量的冒号和值之间存在一个空格。
  • 推荐:
var obj = { 'foo': 'haha' }
  • 不推荐:
var obj = { 'foo' : 'haha' }
  1. 代码块前要添加空格。
  • 推荐:
if (a) {b()
}function a () {}
  • 不推荐:
if (a){b()
}function a (){}
  1. 函数声明括号前要加空格。
  • 推荐:
function func (x) {// ...
}
  • 不推荐:
function func(x) {// ...
}
  1. 在函数调用时,禁止使用空格。
  • 推荐:
fn()
  • 不推荐:
fn ()fn
()
  1. 在操作符前后都需要添加空格。
  • 推荐:
var sum = 1 + 2
  • 不推荐:
var sum = 1+2

附件:https://gitee.com/ZhongBangKeJi/CRMEB

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若转载,请注明出处:http://www.pswp.cn/news/910253.shtml
繁体地址,请注明出处:http://hk.pswp.cn/news/910253.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

游戏技能编辑器开发完全指南系统架构设计之技能编辑器整体架构

技能编辑器整体架构 角色资源划分与管理 1. 角色资源结构 角色资源划分与管理 1. 角色资源结构 // 骨骼重定向示例 void RetargetAnimation(Animation& srcAnim, Skeleton& targetSkeleton) {for (int frame 0; frame < srcAnim.numFrames; frame) {for (Bone&a…

SD-WAN 不是“裸跑”:聊聊怎么把网络安全绑在智能网关上

SD-WAN 不是“裸跑”:聊聊怎么把网络安全绑在智能网关上 一、别被“软件定义”忽悠了:SD-WAN 到底安不安全? 这些年,“SD-WAN”这个词火得不行,听上去高大上,像“云原生网络”、“下一代 WAN 技术”、“运维降本神器”,厂商的 PPT 一个比一个能吹。 但咱搞运维的知道…

国产Linux银河麒麟操作系统上安装开源的视频录制和直播推流OBS Studio软件

一、OBS Studio 简介 OBS Studio (Open Broadcaster Software Studio) 是一款开源的视频录制和直播推流软件&#xff0c;具有以下特点&#xff1a; 跨平台支持&#xff1a;支持 Windows、macOS 和 Linux 系统功能全面&#xff1a; 支持多场景无缝切换提供丰富的音视频源管理内…

Thrift作为客户端流程(多路复用)

以下是一个 使用多路复用&#xff08;TMultiplexedProtocol&#xff09; 的 Thrift 客户端完整流程和关键函数&#xff08;以 Java 为例&#xff09;&#xff0c;适用于当服务端使用 TMultiplexedProcessor 注册了多个服务时&#xff0c;客户端可以区分并调用不同的服务。 ✅ 客…

实现PDF文件添加水印的功能

通过Java代码实现PDF文件添加水印的功能&#xff0c;主要依赖iText库&#xff08;用于PDF操作&#xff09;和OSS SDK&#xff08;可选&#xff0c;用于文件上传&#xff09;。以下是实现的核心步骤&#xff1a; 首先添加依赖 <!-- 添加 PDF 水印 --><dependency>…

Swoft2 框架精华教程:Swoft 的视图组件

概述 用模板对页面进行渲染&#xff0c;这是比较经典的一种设计方式了。主要目的是在服务器端进行页面渲染&#xff0c;以使客户端浏览器可以直接拿到页面 html 的代码&#xff0c;这样对搜索引擎对网站的收录比较友好。如果是前后端分离的形式&#xff0c;由于前后端交互是用…

[学习] 哈希码:原理、用途与实现详解(C代码示例)

哈希码&#xff1a;原理、用途与实现详解 博主在《在C语言中使用字典》一文中&#xff0c;使用哈希来实现键值对的快速检索&#xff0c;今天对哈希这一算法工具&#xff0c;进行一些深入的研究&#xff0c;争取能能做到知其然亦知其所以然。 文章目录 哈希码&#xff1a;原理、…

golang--channel的关键特性和行为

Go 语言 Channel 的核心特性与行为深度解析 Channel 是 Go 语言并发编程的核心组件&#xff0c;用于在不同 goroutine 之间进行通信和同步。以下是其关键特性和行为的全面分析&#xff1a; 一、基本特性 1. 类型安全通信管道 ch : make(chan int) // 只能传递整数2. 方向性…

HarmonyOS 5 鸿蒙多模态融合测试技术方案详解

以下是针对HarmonyOS 5多模态融合测试的技术方案详解&#xff0c;综合交互逻辑、容错机制及分布式验证等核心模块&#xff1a; ‌一、多模态交互核心逻辑验证‌ ‌事件融合机制‌ 通过kit.AbilityKit监听语音指令&#xff0c;结合ArkUI手势系统捕获屏幕坐标&#xff1a; import…

在AI普及的大环境下神经网络在新能源汽车热管理系统中的应用简介

一、神经网络的核心原理与结构 1. 生物启发与基础组成 神经网络&#xff08;Artificial Neural Network, ANN&#xff09;受生物神经元信息处理机制启发&#xff0c;由大量人工神经元互联构成计算模型。每个神经元接收输入信号&#xff08;如温度、流量等物理量&#xff09;&a…

​ CATIA V5与3DEXPERIENCE协同设计:引领无人机行业新纪元

在无人机行业蓬勃发展的今天&#xff0c;传统设计流程正面临前所未有的系统性挑战。更令人担忧的是&#xff0c;随着无人机应用场景的不断拓展&#xff0c;从农业植保到城市物流&#xff0c;从应急救援到军事侦察&#xff0c;对产品性能的要求日益严苛。传统设计方法已难以应对…

关于科技公司经营的一些想法

分析了一些我们公司的问题&#xff1a; 1&#xff0c;测试 重视测试&#xff0c;加大测试投入 2&#xff0c;人才 人才评判标准&#xff1a;结果论&#xff0c;主要根据该岗位问题的解决效率与质量评判。工作时长不重要 任人唯贤。尽可能录用能解决问题的人才&#xff0c;不…

校招生成长日记(一):初来乍到

提前来了几天&#xff0c;感受一下广东的生活。第一印象就是闷热&#xff01;后面尝了潮汕火锅&#xff0c;椰子鸡&#xff0c;荔枝&#xff0c;都很不错&#xff01;&#xff01;&#xff01;就是没有重口味的&#xff0c;好想念我的酸辣粉&#xff0c;麻辣烫啊......y走了瞬间…

【精选】移动端学习平台设计与开发 移动端平台开发(含资料阅读、时事新闻、时政答题与讨论功能) 基于移动端的专题教育平台设计与实现

博主介绍&#xff1a; ✌我是阿龙&#xff0c;一名专注于Java技术领域的程序员&#xff0c;全网拥有10W粉丝。作为CSDN特邀作者、博客专家、新星计划导师&#xff0c;我在计算机毕业设计开发方面积累了丰富的经验。同时&#xff0c;我也是掘金、华为云、阿里云、InfoQ等平台…

Protobuf 高级特性详解 —— 嵌套消息、Oneof 字段与自定义选项

在前几篇文章中&#xff0c;我们已经掌握了 Protocol Buffers&#xff08;Protobuf&#xff09;的基础语法、.proto 文件的结构、以及如何使用 Go 和 Java 进行数据的序列化与反序列化操作。本篇文章将深入探讨 Protobuf 的高级特性&#xff0c;包括&#xff1a; 嵌套消息&…

golang--数据类型与存储

在 Go 语言中&#xff0c;理解值类型&#xff08;value types&#xff09;和引用类型&#xff08;reference types&#xff09;的区别对于编写高效、正确的代码至关重要。以下是主要的区别点和需要注意的特殊情况&#xff1a; 一、值类型&#xff08;Value Types&#xff09; …

uniapp——轮播图、产品列表轮播、上一页、下一页、一屏三张图

案例展示 组件封装 <template><view><view class="showSwiperBox"><view class="topSwiper"><swiper class="swiper" :autoplay="autoplay" interval="5000" :previous-margin="margin&qu…

用Python实现安全封装EXE文件加密保护工具

一、概述 这个Python脚本实现了一个强大的EXE文件加密保护工具,它能够将任何Windows可执行文件封装到一个带密码保护的GUI程序中。核心功能包括: 使用AES-256加密算法保护原始EXE文件 创建美观的密码验证界面 支持自定义程序图标 自动处理PyInstaller打包过程 修复Tkinter在…

vue3监听属性watch和watchEffect的详解

文章目录 1. 前言2. 常规用法3. 监听对象和route变化4. 使用场景4.1 即时表单验证4.2 搜索联想功能4.3 数据变化联动处理 5. watchEffect详解5-1 基本概念5-2 核心用法基础示例&#xff1a;自动响应依赖变化处理异步副作用停止监听与清理副作用 5-3 高级场景应用监听多个响应式…

Spring IoC核心实现揭秘

Spring IoC(控制反转)的实现机制是Spring框架的核心,其本质是将对象的创建、依赖管理和生命周期控制权从应用程序代码转移到容器中。以下是其核心实现机制: 🔧 一、核心实现步骤 配置元数据加载 容器启动时读取XML/注解/Java配置类,解析为BeanDefinition对象(包含类名、…