前端開發(fā)設(shè)計規(guī)范文檔(編輯修改稿)
2025-05-05 13:12 本頁面
【文章內(nèi)容簡介】 、變量名必須使用其類型的縮寫字符串開始。各種類型的縮寫字符串如下： 變量類型縮寫變量類型縮寫整型變量int長整型變量lng浮點型變量flt雙精度變量dbl對象變量obj字符串變量strDate類型變量dtm數(shù)組ary臨時變量tmp4) 、變量名必須采用有意義的單詞命名，如：strUserName、lngArrayIndex，以及不要出現(xiàn)數(shù)字編號命名，如：value1，value2…5) 、如果變量名過長可以使用單詞縮寫，除了被廣泛了解的單詞縮寫以外，所有使用單詞縮寫的變量名必須在定義時給出注釋，如： 6) 、參數(shù)變量命名必須加前綴：p_。7) 、function命名規(guī)范：使用動詞+名詞的方式，并且命名需要明確指出其作用，動詞前綴必須是同函數(shù)功能相關(guān)的完整動詞，如getUserId（），用來取用戶Id。8) 、所有命名使用小駝峰命名法：第一個單詞全部使用小寫，其他單詞首字母大寫，如：myClassName。四、css樣式規(guī)范、css樣式文件命名規(guī)范、通用樣式文件命名規(guī)范：1) 、整個項目通用的css布局樣式文件命名為：。如：通過于整個網(wǎng)站中使用的div、himg等的定義文件。2) 、對引用的開源css樣式重定義的文件命名為：如：，這類樣式的文件名命名為：。一個項目建議最多使用一個css框架。3) 、外部引用的字體css樣式文件命名為：，若有多個字體引用則使用：。4) 、自定義的響應(yīng)式布局樣式命名為：項目名稱縮寫–。5) 、跨項目通用功能定義的css樣式文件命名為：。6) 、為IE瀏覽器做兼容處理的樣式命名為：。、業(yè)務(wù)類樣式文件命名規(guī)范自定義的樣式統(tǒng)一定義在一個文件內(nèi)，文件命名為：。、css樣式文件命名須知1) 、以上所有的css樣式文件命名必須是小寫字母，不允許中文、大寫字母及其他特殊字符等。如果有樣式版本共存或更新需要保留老版本樣式，請在樣式文件名后面加上“版本號”，最新版本樣式文件除外，同樣版本號只允許是數(shù)字或小寫字母。2) 、以上css文件命名制定的規(guī)范只適用普遍的情況，特殊情況下請開發(fā)人員根據(jù)實際情況自行命名，但必須遵行1)的規(guī)定。、css樣式文件存放目錄規(guī)范項目文件存放目錄將在后面說明，此處只針對css樣式文件存放規(guī)定。1) 、字體樣式文件存放文件夾：/font/，包括字體的源文件。2) 、引用的樣式保持原來的目錄結(jié)構(gòu)，如果有多個引用的樣式則按功能新建文件夾來分別存放。3) 、其他樣式文件不用單獨新建文件夾。、css樣式定義規(guī)范、css樣式內(nèi)容頂部注釋規(guī)范1) 、請使用utf8編碼。2) 、申明css定義的內(nèi)容概述或目的，申明編寫的人員、更新日期。3) 、請謹慎使用@import url(……)引入其他css樣式文件。、css樣式內(nèi)容注釋規(guī)范1) 、模塊注釋必須單獨寫在一行，簡要說明模塊的功能。2) 、單行注釋可以寫在單獨一行，也可以寫在行尾，注釋中的每一行長度不超過30個漢字，或者60個英文字符。3) 、多行注釋必須寫在單獨行內(nèi)，即/*后換行寫注釋，*/單獨寫一行。4) 、用于標(biāo)注修改、待辦等信息的注釋以單行注釋為基準。5) 、對一個代碼區(qū)塊注釋（可選），將樣式語句分區(qū)塊并在新行中對其注釋。、css樣式定義規(guī)范1) 、使用有意義的或通用的id和class命名：id和class的命名應(yīng)反映該元素的功能或使用通用名稱，而不要用抽象的晦澀的命名。反映元素的使用目的是首選；使用通用名稱代表該元素不表特定意義，與其同級元素?zé)o異，通常是用于輔助命名；使用功能性或通用的名稱可以更適用于文檔或模版變化的情況。2) 、id和class命名越簡短越好，只要足夠表達涵義。這樣既有助于理解，也能提高代碼效率。3) 、常用命名（多記多查英文單詞）：page、wrap、layout、header(head)、footer(foot、ft)、 content(cont)、menu、nav、main、submain、sidebar(side)、logo、banner、 title(tit)、popo(pop)、icon、note、btn、txt、iblock、window(win)、tips等。4) 、類型選擇器避免同時使用標(biāo)簽、id和class作為定位一個元素選擇器，可以使用class層級來代替。 5) 、規(guī)則命名中，一律采用小寫加中劃線的方式，不允許使用大寫字母或下劃線。6) 、命名避免使用中文拼音，應(yīng)該采用更簡明有語義的英文單詞進行組合。7) 、命名注意縮寫，但是不能盲目縮寫，具體請參見常用的CSS命名規(guī)則。8) 、不允許通過3等序號進行命名，避免class與id重名。9)
公司管理相關(guān)推薦
鄂ICP備17016276號-1