自我總結代碼規范，歡迎修正

MASAILA 發布于2019-08-23 17:12 / 626人閱讀

摘要：函數塊不要太長，太長影響閱讀，一個函數做一件事避免冗余代碼和重復代碼一個文件做一件事，整個文件代碼不能太長，保持在行以內不要提交直接執行的信息，影響它人調試不要提交沒用的注釋代碼，影響閱讀和開發，如果要查看可以進行版本歷史我的代碼規范原則影

函數塊不要太長，太長影響閱讀，一個函數做一件事

避免冗余代碼和重復代碼

一個文件做一件事，整個文件代碼不能太長，保持在300~500行以內

不要提交直接執行的console.log信息，影響它人調試

不要提交沒用的注釋代碼，影響閱讀和開發，如果要查看可以進行版本歷史

我的代碼規范原則

影響閱讀的代碼，那就是不好代碼

很多很相似的代碼，那一定是重復冗余了

以下是最近在某代碼倉庫js中發現不規范的代碼，當然還有css規范了，有興趣的可以自己上網搜索

代碼規范和不規范舉例 函數塊不要太長，太長影響閱讀，一個函數做一件事

太長的函數塊:建議函數塊以編輯器的一屏為準，幾乎不用滾動條可以看完整個函數

可以看到這里的函數每行30行至更多。打開后必須滾動條才能看清楚這個函數

改良后的函數塊

一個函數平均10-20行之間

避免冗余代碼和重復代碼

冗余代碼示例

如果你發現了很多地方代碼很相似，那肯定是代碼重復冗余了

改良后冗余代碼示例

發現重復和冗余的規律，統一用函數封裝起來

一個文件做一件事，整個文件代碼不能太長，保持在300~500行以內

文件代碼結構劃分

一個method可以拆分成文件夾，通過index入口導入

一個文件做一件事，可以看到一個文件才不到200行

還有文件順序問題，比如vue鉤子函數，建議不用把created寫在最后

文件夾結構

公共的css提出來

公共的方法用mixin提出來

不要提交直接執行的console.log信息，影響它人調試

及時運行的log信息

寫代碼的時候可以用，提交盡量不要提交console.*信息

雜亂的log控制臺

不要提交沒用的注釋代碼，影響閱讀和開發，如果要查看可以進行版本歷史

不要提交注釋代碼可在版本歷史查看

版本歷史

一起努力吧

--
作者：劉偉波

鏈接：http://www.liuweibo.cn/p/252

來源：劉偉波博客

本文原創版權屬于劉偉波，轉載請注明出處，謝謝合作

GPU云服務器云服務器代碼規范代碼規范考試 java代碼性能總結 java代碼注釋規范

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/103973.html

PHP代碼修正之CodeSniffer

摘要：它包含兩類腳本，和地址腳本對文件定義了一系列的代碼規范通常使用官方的代碼規范標準，比如的，能夠檢測出不符合代碼規范的代碼并發出警告或報錯可設置報錯等級。腳本能自動修正代碼格式上不符合規范的部分。 Last-Modified: 2019年5月10日13:59:27 參考鏈接 PHP開發規范之使用phpcbf腳本自動修正代碼格式在PhpStorm中使用PSR2編碼規范phpcbf腳本自...

khs1994 2019-07-01 12:45 評論0 收藏0
前端JS代碼規范

摘要：縮進為個空格句末必須用分號結尾待定就無分號注釋單行注釋多行注釋代碼注釋和再提交重要函數或者類等都要添加頭描述字符串拼接應使用數組保存字符串片段，使用時調用方法。前言下面這幾點將工作中所踩的一些坑簡單整理了一下,團隊幾個人開發,一些默契就比較重要,可以提高開發效率和代碼的可讀性命名,編碼和注釋命名 A.文件夾命名:文件夾、文件的命名與命名空間應能代表代碼功能,可讀性強,如hubB...

zhiwei 2019-08-21 18:24 評論0 收藏0
【譯】ECMAScript文檔---序言及1-6章（上）

摘要：隨后，它出現在公司之后的瀏覽器，以及從微軟從起發布的所有瀏覽器上。標準的第版在年月的大會上被表決接受。第版在年月底大會上被采納。前言 ??本系列譯文的初衷旨在希望更多人能夠了解關于JS的一些基本概念，遇到原理性的問題時多去翻翻文檔，而不是在社區無休止的重復提出某些在文檔中能夠非常方便快捷就能找到的東西。 ??精力和水平有限，所以暫時只打算嘗試翻譯前面幾章概括性的介紹，同時后面的章節大...

wind3110991 2019-08-20 18:32 評論0 收藏0
React.js 最佳實踐（2016）_鏈接修正版

摘要：譯者按最近依舊如火如荼相信大家都躍躍欲試我們團隊也開始在領域有所嘗試年應該是逐漸走向成熟的一年讓我們一起來看看國外的開發者們都總結了哪些最佳實踐年在全世界都有很多關于新的更新和開發者大會的討論關于去年的重要事件請參考那么年最有趣的問題來了我譯者按：最近React(web/native)依舊如火如荼,相信大家都躍躍欲試,我們團隊也開始在React領域有所嘗試. 2016年應該是Reac...

syoya 2019-08-19 17:57 評論0 收藏0