摘要:函數(shù)塊不要太長(zhǎng),太長(zhǎng)影響閱讀,一個(gè)函數(shù)做一件事避免冗余代碼和重復(fù)代碼一個(gè)文件做一件事,整個(gè)文件代碼不能太長(zhǎng),保持在行以內(nèi)不要提交直接執(zhí)行的信息,影響它人調(diào)試不要提交沒(méi)用的注釋代碼,影響閱讀和開(kāi)發(fā),如果要查看可以進(jìn)行版本歷史我的代碼規(guī)范原則影
我的代碼規(guī)范原則函數(shù)塊不要太長(zhǎng),太長(zhǎng)影響閱讀,一個(gè)函數(shù)做一件事
避免冗余代碼和重復(fù)代碼
一個(gè)文件做一件事, 整個(gè)文件代碼不能太長(zhǎng),保持在300~500行以內(nèi)
不要提交直接執(zhí)行的console.log信息,影響它人調(diào)試
不要提交沒(méi)用的注釋代碼,影響閱讀和開(kāi)發(fā),如果要查看可以進(jìn)行版本歷史
影響閱讀的代碼,那就是不好代碼
很多很相似的代碼,那一定是重復(fù)冗余了
以下是最近在某代碼倉(cāng)庫(kù)js中發(fā)現(xiàn)不規(guī)范的代碼,當(dāng)然還有css規(guī)范了,有興趣的可以自己上網(wǎng)搜索
代碼規(guī)范和不規(guī)范舉例 函數(shù)塊不要太長(zhǎng),太長(zhǎng)影響閱讀,一個(gè)函數(shù)做一件事太長(zhǎng)的函數(shù)塊:建議函數(shù)塊以編輯器的一屏為準(zhǔn),幾乎不用滾動(dòng)條可以看完整個(gè)函數(shù)
可以看到這里的函數(shù)每行30行至更多。打開(kāi)后必須滾動(dòng)條才能看清楚這個(gè)函數(shù)
改良后的函數(shù)塊
一個(gè)函數(shù)平均10-20行之間
避免冗余代碼和重復(fù)代碼冗余代碼示例
如果你發(fā)現(xiàn)了很多地方代碼很相似,那肯定是代碼重復(fù)冗余了
改良后冗余代碼示例
發(fā)現(xiàn)重復(fù)和冗余的規(guī)律,統(tǒng)一用函數(shù)封裝起來(lái)
一個(gè)文件做一件事, 整個(gè)文件代碼不能太長(zhǎng),保持在300~500行以內(nèi)文件代碼結(jié)構(gòu)劃分
一個(gè)method可以拆分成文件夾,通過(guò)index入口導(dǎo)入
一個(gè)文件做一件事,可以看到一個(gè)文件才不到200行
還有文件順序問(wèn)題,比如vue鉤子函數(shù),建議不用把created寫在最后
文件夾結(jié)構(gòu)
公共的css提出來(lái)
公共的方法用mixin提出來(lái)
不要提交直接執(zhí)行的console.log信息,影響它人調(diào)試及時(shí)運(yùn)行的log信息
寫代碼的時(shí)候可以用,提交盡量不要提交console.*信息
雜亂的log控制臺(tái)
不要提交沒(méi)用的注釋代碼,影響閱讀和開(kāi)發(fā),如果要查看可以進(jìn)行版本歷史不要提交注釋代碼可在版本歷史查看
版本歷史
一起努力吧--
作者:劉偉波
鏈接:http://www.liuweibo.cn/p/252
來(lái)源:劉偉波博客
本文原創(chuàng)版權(quán)屬于劉偉波 ,轉(zhuǎn)載請(qǐng)注明出處,謝謝合作
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://m.specialneedsforspecialkids.com/yun/103973.html
摘要:它包含兩類腳本,和地址腳本對(duì)文件定義了一系列的代碼規(guī)范通常使用官方的代碼規(guī)范標(biāo)準(zhǔn),比如的,能夠檢測(cè)出不符合代碼規(guī)范的代碼并發(fā)出警告或報(bào)錯(cuò)可設(shè)置報(bào)錯(cuò)等級(jí)。腳本能自動(dòng)修正代碼格式上不符合規(guī)范的部分。 Last-Modified: 2019年5月10日13:59:27 參考鏈接 PHP開(kāi)發(fā)規(guī)范之使用phpcbf腳本自動(dòng)修正代碼格式 在PhpStorm中使用PSR2編碼規(guī)范phpcbf腳本自...
摘要:縮進(jìn)為個(gè)空格句末必須用分號(hào)結(jié)尾待定就無(wú)分號(hào)注釋單行注釋多行注釋代碼注釋和再提交重要函數(shù)或者類等都要添加頭描述字符串拼接應(yīng)使用數(shù)組保存字符串片段,使用時(shí)調(diào)用方法。 前言 下面這幾點(diǎn)將工作中所踩的一些坑簡(jiǎn)單整理了一下,團(tuán)隊(duì)幾個(gè)人開(kāi)發(fā),一些默契就比較重要,可以提高開(kāi)發(fā)效率和代碼的可讀性 命名,編碼和注釋 命名 A.文件夾命名:文件夾、文件的命名與命名空間應(yīng)能代表代碼功能,可讀性強(qiáng),如hubB...
摘要:隨后,它出現(xiàn)在公司之后的瀏覽器,以及從微軟從起發(fā)布的所有瀏覽器上。標(biāo)準(zhǔn)的第版在年月的大會(huì)上被表決接受。第版在年月底大會(huì)上被采納。 前言 ??本系列譯文的初衷旨在希望更多人能夠了解關(guān)于JS的一些基本概念,遇到原理性的問(wèn)題時(shí)多去翻翻文檔,而不是在社區(qū)無(wú)休止的重復(fù)提出某些在文檔中能夠非常方便快捷就能找到的東西。 ??精力和水平有限,所以暫時(shí)只打算嘗試翻譯前面幾章概括性的介紹,同時(shí)后面的章節(jié)大...
摘要:譯者按最近依舊如火如荼相信大家都躍躍欲試我們團(tuán)隊(duì)也開(kāi)始在領(lǐng)域有所嘗試年應(yīng)該是逐漸走向成熟的一年讓我們一起來(lái)看看國(guó)外的開(kāi)發(fā)者們都總結(jié)了哪些最佳實(shí)踐年在全世界都有很多關(guān)于新的更新和開(kāi)發(fā)者大會(huì)的討論關(guān)于去年的重要事件請(qǐng)參考那么年最有趣的問(wèn)題來(lái)了我 譯者按:最近React(web/native)依舊如火如荼,相信大家都躍躍欲試,我們團(tuán)隊(duì)也開(kāi)始在React領(lǐng)域有所嘗試. 2016年應(yīng)該是Reac...
閱讀 2845·2023-04-25 20:02
閱讀 1444·2021-11-11 16:55
閱讀 631·2021-09-26 09:46
閱讀 6218·2021-09-22 15:55
閱讀 1828·2021-08-09 13:41
閱讀 1582·2019-08-30 15:52
閱讀 2380·2019-08-30 14:13
閱讀 3301·2019-08-26 13:48