1. 程式人生 > >程式碼審查工具 StyleCop 的探索

程式碼審查工具 StyleCop 的探索

最近我們Advent Data Service (ADS) 在專案上需要按照程式碼規範進行程式碼的編寫工作,以方便將來程式碼的閱讀與維護。

但是人工檢查起來容易遺漏或者格式不統一, ReSharper又是收費的,而且費用不菲。

於是美國的同事推薦了我們一款開源工具 StyleCop,我想無論是對公司專案還是個人的專案,都是有所幫助的,所以想寫下來與大家分享。

  • 現在最新的版本是 4.7.50,這是一個Alpah版本,支援Visual Studio 2015 (暫時不支援C# 6.0的語法)

 

  • StyleCop有兩種安裝方式
    • 直接在官網下載msi安裝程式,雙擊安裝
    • 在Visual Studio中,Tools --> Extensions and Updates… --> Extensions and Updates… --> Online --> 搜尋stylecop,找到Visual StyleCop並安裝

 

  • 安裝完成之後,開啟Visual Studio並開啟一個專案,右鍵選擇一個Project,會發現多了三個選項

 

  • Run StyleCop與Run StyleCop(Rescan All)會審查已有程式碼,並且在Error List中顯示程式碼中不符合規範的Warning

第一個圖是執行了Run StyleCop的Error List, 第二個圖是執行了Build的Error List

   

  • StyleCop Setting:在實際專案中,可能現有的規則並不適用於我們的專案,需要我們自己通過StyleCop Setting進行配置

 

以上都是StyleCop的基本功能,希望能對大家有所幫助,也歡迎大家進行交流討論。

Tips: 在Visual Studio中,規範化C#專案程式碼格式的快捷鍵是Ctrl + k,再按一下Ctrl + d。在編寫完程式碼後,按下這個組合,程式碼就會規規矩矩的排列了☺

相關推薦

程式碼審查工具 StyleCop探索

最近我們Advent Data Service (ADS) 在專案上需要按照程式碼規範進行程式碼的編寫工作,以方便將來程式碼的閱讀與維護。 但是人工檢查起來容易遺漏或者格式不統一, ReSharper又是收費的,而且費用不菲。 於是美國的同事推薦了我們一款開源工具 StyleCop,我想無論是對公司專案還

最好用程式碼審查工具Understand for Mac破解版v5.0

understand mac 破解版是mac平臺上一款非常強大的程式碼審查工具,可以幫助程式設計師快速理解,衡量,維護和記錄他們的原始碼。understand mac 破解介面是用Qt開發的,支援多語言、多平臺,內建的目錄和檔案比較器。Understand Mac主要功能包括:語義變化分析,優化指標,組合

最好用程式碼審查工具Understand for Mac破解版 v5.0(972)破解教程

瞭解MAC破解版是MAC平臺上一款非常強大的程式碼審查工具,可以幫助程式設計師快速理解,衡量,維護和記錄他們的原始碼。瞭解MAC破解介面是用Qt開發的,支援多語言,多平臺,內建的目錄和檔案比較器解讀Mac的主要功能包括:語義變化分析,優化指標,組合語言分析,自定義的建築創作,程式碼分析快照的建立。

程式猿必備的17款最佳的程式碼審查工具

好的程式碼審查器可以大大地幫助程式設計師提高程式碼質量,減少錯誤機率。 雖然現在市場上有許多可用的程式碼審查工具,但如何挑選也是一個艱鉅的任務。在諮詢過有關專家的建議和意見之後,我們羅列出了以下17款最佳的程式碼審查工具。 Python學習資料或者需要程式碼、視訊加Python學習群:960

FindBugs Java程式碼審查工具

簡介編輯 儘管如此,好的靜態分析工具仍然是工具箱中的無價之寶。在這個由兩部分組成的系列文章的第一部分中,高階軟體工程師 Chris Grindstaff 分析了 FindBugs 如何幫助提高程式碼質量以及排除隱含的缺陷。程式碼質量工具的一個問題是它們容易為開發人員提供

最佳的程式碼審查工具

CodeStriker是一個免費&開源的Web應用程式,可以幫助開發人員基於Web的程式碼審查。 RhodeCode是一款非常棒的程式碼審查工具,能讓你發現程式碼中的bug和問題。 Codebrag是一款簡單輕巧,提高程序作為的程式碼審查工具。 P

lint 程式碼審查工具

基本介紹 lint是最著名的C語言工具之一,是由貝爾實驗室SteveJohnson於1979在PCC(PortableC Compiler)基礎上開發的靜態程式碼分析,一般由UNIX系統提供。與大多數C語言編譯器相比,lint可以對程式進行更加廣泛的錯誤分析,是一種更加

Jupiter程式碼審查工具使用參考

備註:IE6核心的瀏覽器圖片總是出不來,建 議使用Mozilla Firefox,Opera,谷歌瀏覽器  一、       Jupiter 是什麼? 這裡的 Jupiter 是一個開源的程式碼審查工具,是整合在 Eclipse 下執行程式碼審查工作一個很棒的工具。 可以把

【工利其器】Android Lint篇——為Android量身定做的靜態程式碼審查工具

前言        我們在進行程式碼優化的時候,往往是通過開發者的經驗來判斷哪些程式碼可能存在潛在問題,哪些資源的使用不合規範等。實際上Android SDK提供了一款功能非常強大的工具,來幫助開發者自動檢測程式碼的質量及安全問題,這款工具就叫Android Lint。

StyleCop 程式碼審查(VS外掛)

程式碼審查:StyleCop  (介紹,下載,使用,自定義規則,原始碼) StyleCop簡介: StyleCop是程式碼規範檢查工具(Code Review 工具),它不僅僅檢查程式碼格式,而是編碼規範,包括命名和註釋等。StyleCop可以幫助你更容易地進行這項活動。St

C# 程式碼規範和質量檢查工具 StyleCop.Analyzers

簡介 原來一直用 ReSharper 來進行程式碼質量檢查,不過畢竟是收費的,所以想找個免費的可以推廣給公司的同事也一起用。搜尋了一下,找到了StyleCop,但是我在 VS 2015裡安裝 StyleCop 或者通過 Nuget 包安裝 StyleCop.MSBuild,雖然編譯以後能把 warning

在Eclipse中配置程式碼審查與分析工具

1、Checkstyle 1、 2、 將壓縮包解壓。 3、 將features和plugins兩個資料夾中的內容放到eclipse安裝目錄中對應的位置。 4、 重啟eclipse,在eclipse.exe所在目錄下啟動命令列

代碼審查工具

意見 聲明 force 服務 dia google detailed coo 當前 來自:coolshell Code Review中文應該譯作“代碼審查”或是“代碼評審”,這是一個流程,當開發人員寫好代碼後,需要讓別人來r

推薦程式碼除錯工具 Xdebug

寫程式碼總繞不過需要除錯,除了 UnitTest 外,我們還是需要藉助 Xdebug 進行除錯。 所以今天來說說如何基於本地 Docker 環境下,使用 Xdebug。 這裡的使用,是分別整合到 VS Code 和 PHPStorm 下。 安裝 Xdebug 還是基於神級武

SVN 線上程式碼託管工具

分享一下我老師大神的人工智慧教程!零基礎,通俗易懂!http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識,造福人民,實現我們中華民族偉大復興!        

mybatis程式碼生成工具 mybatis-generator

            mybatis-generator-1.0使用手冊 1.    編寫目的 1.1.前面的話 每個專案開始,都會寫到servi

程式碼規範工具大比拼---Alibaba Java Coding Guidelines

                  程式碼規範工具大比拼---Alibaba Java Coding Guidelines &n

java程式碼-Exccel工具

package com.ufc.utils; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStrea

使用程式碼生成工具Database2Sharp快速生成工作流模組控制器和檢視程式碼

在前面隨筆《基於Metronic的Bootstrap開發框架--工作流模組功能介紹》和《基於Metronic的Bootstrap開發框架--工作流模組功能介紹(2)》中介紹了Bootstrap開發框架的工作模組功能,前面文章也提及,通過程式碼生成工具直接生成對應的Create、ViewDetail、Index

PVS-Studio C/C++/C++11 靜態程式碼分析工具

  靜態程式碼分析儀是一種檢測程式碼缺陷、分析對比 商業程式碼的工具,它分析原始碼和它生成的目標 檔案,但並不實際執行原始碼。應用於對安全性、 穩定性要求很高的領域,比如航天、國防、工業 控制、金融等就需要嚴格的程式碼分析工具。PVS-Studio 能發現程式碼中一些潛