前端CodeReivew實踐

来源:https://www.cnblogs.com/jingdongkeji/archive/2023/10/24/17784521.html
-Advertisement-
Play Games

把Code Review 作為開發流程的必選項後,不代表Code Review這件事就可以執行的很好,因為Code Review 的執行,很大部分程度上依賴於審查者的認真審查,以及被審查者的積極配合,兩者缺一不可! ...


把Code Review變成一種開發文化而不僅僅是一種制度

把Code Review 作為開發流程的必選項後,不代表Code Review這件事就可以執行的很好,因為Code Review 的執行,很大部分程度上依賴於審查者的認真審查,以及被審查者的積極配合,兩者缺一不可!

如果僅僅只是當作一個流程制度,那麼就可能會流於形式。最終結果就是看起來有Code Review,但沒有人認真審查,隨便看下就通過了,或者發現問題也不願意修改。

真要把Code Review這件事做好,必須讓Code Review變成團隊的一種文化,開發人員從心底接受這件事,並認真執行這件事。

要形成這樣的文化,不那麼容易,也沒有想象的那麼難,比如這些方面可以參考:

  • 首先,得讓開發人員認識到Code Review這件事為自己、為團隊帶來的好處
  • 然後,得要有幾個人做好表率作用,榜樣的力量很重要
  • 還有,對於管理者來說,你激勵什麼,往往就會得到什麼
  • 最後,像寫自動化測試一樣,把Code Review要作為開發任務的一部分,給審查者和被審查者都留出專門的時間去做這件事,不能光想著馬兒跑得快又捨不得給馬兒吃草

如何形成這樣的文化,有心的話,還有很多方法可以嘗試。只有真正讓大家都認同和踐行,才可能去做好Code Review這件事。

自動化工具及規則

前端代碼規範

  1. eslint config
  2. coding里增加eslint的掃描

掃出來問題很多:後端也在改,每個迭代修改幾類。這個需要大家看看是否參考後端的方式,定期梳理一批

提交MR前的必要條件

  • 先設計再編碼

建議大家在做複雜功能設計之前可以內部先簡單進行一輪頭腦碰撞,看一下是否思路可行,或者大家可以一起看一下是否有更好的實現方案。否則review的時候大部分邏輯都寫完了,如果有更好的方案,不一定能在review的時候再提出修改了,就算提出了,也可能會涉及大量代碼的重寫,最終耽誤工期。

  • 本地代碼通過eslint審查

在提交代碼前,請確保error、warning都已處理完畢。有必要忽略eslint校驗時可以考慮使用

/* eslint-disable */

/* eslint-disable no-param-reassign */

// eslint-disable-next-line,

否則肉眼的力量是有限的

  • PR要小

在做Code Review的時候,如果有大量的文件修改,那麼Review起來是很困難的,但如果PR比較小,相對就比較容易Review,也容易發現代碼中可能存在的問題。

有必要的話,可以拆分功能點,分階段提交MR,提交的時候標註僅review還是review+merge

  • 開發要預留時間,你的Reviewer也要提前周知預留時間

如何review

對評論進行分級

在做Code Review時,需要針對審查出有問題的代碼行添加評論,如果只是評論,有時候對於被審查者比較難甄別評論所代表的含義,是不是必須要修改。

建議可以對Review的評論進行分級,不同級別的結果可以打上不同的Tag,比如說:

  • [blocker]在評論前面加上一個blocker標記,表示這個代碼行的問題必須要修改
  • [optional]:在評論前面加上一個[optional]標記,表示這個代碼行的問題可改可不改
  • [question]:在評論前面加上一個[question]標記,表示對這個代碼行不理解,有問題需要問,被審查者需要針對問題進行回覆澄清

類似這樣的分級可以幫助被審查者直觀瞭解Review結果,提高Review效率。

文件結構的檢查

  • 是否符合代碼工程目前形成的常用文件結構
  • 文件命名規範
  • 文件放置的位置是否合理(比如demand的組件不能放到teamspace下)

書寫風格

變數

駝峰式命名

let cardList;
let cardListButton;
function getCardList(){}

常量

全部大寫,使用下劃線來分割單詞

const TIMEOUT = 10000;
const MAX_LENGHT = 10;

Function

對應的方法應該使用對應的動詞,例如:

get/set, add/remove, create/destroy, start/stop, insert/delete, begin/end;

駝峰式命名;

構造函數的函數名,採用首字母大寫(InitialCap);其他函數名,一律首字母小寫。

css規範

命名規範:BEM+ Utility-first

No全局污染


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 通過實時索引、查詢和全文搜索引擎,Redis Enterprise提供了更好的數據檢索解決方案。通過強大的搜索引擎助力,Redis Enterprise能在亞毫秒級的時間內提供結果,以增強客戶體驗並助力商業智能。 ...
  • 本文分享自華為雲社區《GaussDB(DWS)性能調優:實時場景下表行數估算不准確引起的的性能瓶頸問題案例》,作者: O泡果奶~。 本文針對實時場景下SQL語句因表行數估算不准確而導致語句執行超時報錯的案例進行分析。 1、【問題描述】 實時場景下,select查詢語句執行時間過長,該語句verbos ...
  • 數據泄露對企業的影響是嚴重的,包括商業機密泄露、法律責任和信譽喪失。為了降低數據泄露的風險,NineData推出了SQL開發規範和用戶訪問量管理功能。用戶訪問量管理功能可以根據用戶的職責和工作需求,靈活配置訪問量,並對特定用戶單獨配置訪問量,並設置到期時間。這個功能適用於數據安全、法律合規和應急響應... ...
  • 1、華為官網介紹 2、OpenHarmony開源項目 3、技術架構 內核層 內核子系統:採用多內核(Linux內核或者LiteOS)設計,支持針對不同資源受限設備選用適合的OS內核 驅動子系統:驅動框架(HDF)是系統硬體生態開放的基礎,提供統一外設訪問能力和驅動開發、管理框架。 系統服務層 系統服 ...
  • 1 它是什麼(協程 和 Kotlin協程) 1.1 協程是什麼 維基百科:協程,英文Coroutine [kəru’tin] (可入廳),是電腦程式的一類組件,推廣了協作式多任務的子程式,允許執行被掛起與被恢復。 作為Google欽定的Android開發首選語言Kotlin,協程並不是 Kotli ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 前言 在前端開發中,有時候一些業務場景中,我們有需求要去實現excel的預覽和列印功能,本文在vue3中如何實現Excel文件的預覽和列印。 預覽excel 關於實現excel文檔線上預覽的做法,一種方式是通過講文檔里的數據處理成html ...
  • 在js中,js變數和JSON是兩個不同數據格式,兩者的儲存方式自然不相同。JSON格式是一種數據交換的規則,js變數則是javascript在程式需求場景中的數據表示。在js與不同語言的服務端進行數據交換過程中,js能夠有內置的方法將其變數轉化為JSON格式。 JSON.parse(data);// ...
  • 我們是袋鼠雲數棧 UED 團隊,致力於打造優秀的一站式數據中台產品。我們始終保持工匠精神,探索前端道路,為社區積累並傳播經驗價值。 本文作者:的盧 引入 在日常開發過程中,我們會使用很多性能優化的 API,比如像使用 memo、useMemo優化組件或者值,再比如使用 shouldComponent ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...