版本:v1.0
日期:2022-01-15
壹:命名規範
英文單詞在命名中的使用簡單易懂。
項目命名
使用小寫字母，多個單詞用“-”拼接。
比如:我的世界/世界
文件夾命名
使用小寫字母，多個單詞用“-”拼接。
例如:主頁/主頁
文件命名
使用小寫字母，多個單詞用“-”拼接。
例如:主頁/主頁
變量命名
以壹個小駝峰命名。如果壹個文件中有太多變量，可能會有重名。建議添加前綴，以區分不同功能的變量。或將變量拆分到不同的文件中。
示例:最大高度/用戶最大高度/家庭最大高度。
常數命名
全部使用大寫字母。多個單詞由下劃線“_”分隔。
例如:const user _ type = " 9001 "；
函數命名
規範1:用小駝峰命名。繼承的父類的私有函數需要以下劃線“_getPrice()”為前綴。
例如:showToast/_getPrice
規範2:根據功能適當添加動詞前綴。
例如:getSize/setSize/hasNumber。
前綴請參考文檔底部的“附錄1:(函數命名動詞前綴集成)”。
第二:註釋規範
通俗易懂的變量方法，盡量寫註釋。復雜變量方法，必須寫註釋。
單行註釋//
在代碼頂行寫壹行註釋，下面簡單介紹代碼的用途和註意事項。
多行註釋/* */或/* */
方法必須使用多行註釋。當變量或代碼塊比較復雜，單行註釋不足以解釋清楚時，也需要多行註釋。
例如:
//商品名稱
商品名稱:“獼猴桃”，
/**
*錄入人員姓名，從數據庫中查詢該人員的手機號碼。
* @param {String}用戶名
* @return {Number}手機號碼
*/
getUserMobile(用戶名){
......
歸還手機；
},
三:CSS規範
1.類類名用小寫字母，多個單詞用“-”拼接。
2.ID是以壹個小駝峰命名的。
3.SCSS及以下的變量、函數和混合都用小駝峰命名。
4.縮進整齊有序。
四:項目規格
項目結構的建議說明(根據具體需求邏輯實際調整)
科學研究委員會
Api所有接口封裝
Asstes資源文件
-圖像圖片
-視頻
組件所有組件
路由器路由
商店狀態管理
樣式樣式
Utils公共函數庫
視圖視圖
-主視圖文件需要存儲在模塊和文件夾中
home.vue
主頁-詳細信息.視圖
-用戶
五:附件
附錄1:(函數命名動詞前綴集成)