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?移動至容器元素上 (比如?ul,?ol)。
<!-- 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
英文地址,請注明出處:http://en.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對象(包含類名、…