前言

「使用StyleCop驗證命名規則」這篇文章,指引開發人員透過StyleCop這個工具,來自動檢驗專案中產出的程式碼是否合乎命名規則。

但是在專案開發的過程中,如果只是驗證命名規則、而沒有統一程式排版,專案中很容易就會出現類似下列範例的程式碼產出。這樣的產出,雖然能夠正常地提供專案功能、並且符合微軟的命名規則,但是因為程式排版凌亂的問題,大幅降低了這份程式碼的可維護性。

  • Bad Code

    public class Class1
    {
    private string _name = "Clark"; public string GetResult()
    {
    return (_count01 + _count02).ToString();
    } private int _count01 = 1; private int _count03 = 3; public string GetName()
    {
    return _name;
    } private int _count02 = 2;
    }

本篇文章介紹如何透過CodeMaid這個工具,來自動整理專案中程式碼的排版,在不增加開發人員負擔的前提下,讓團隊的程式碼產出趨於一致、大幅提高程式碼的生產品質。主要為自己留個紀錄,也希望能幫助到有需要的開發人員。

  • Good Code

    public class Class1
    {
    private int _count01 = 1;
    private int _count02 = 2;
    private int _count03 = 3;
    private string _name = "Clark"; public string GetName()
    {
    return _name;
    } public string GetResult()
    {
    return (_count01 + _count02).ToString();
    }
    }

安裝

  1. 首先至微軟的官方網站,下載CodeMaid安裝檔:「CodeMaid_v0.7.4.vsix」。

  2. 執行CodeMaid安裝檔:「CodeMaid_v0.7.4.vsix」,來安裝CodeMaid。

執行

  1. 使用Visual Studio開啟專案。

  2. Visual Studio上方工具列中,開啟CODEMAID選單、點選Configuration來開啟CodeMaid設定畫面。

  3. CodeMaid設定畫面中,進入Reorganizing->General設定頁面,勾選「Run organize at start cleanup」後,點擊Save按鈕完成設定。

  4. 後續就可以從Visual Studio上方工具列中,開啟CODEMAID選單、點選「Cleanup all Code」來自動排版專案內的所有程式碼。

  5. 自動排版功能執行結束之後,開啟專案內的程式碼,會發現程式碼內容已經排列整齊,大幅提高程式碼的可維護性。

延伸

CodeMaid所提供的程式碼自動排版功能,用起來很方便、排版結果也很簡潔。但是在一些細節上,總是會有些許的排版定義,不符合團隊成員對於程式碼品質的要求。不過還好的是,CodeMaid開放了許多排版條件的設定項目,讓開發人員可以調整排版條件,來讓排版結果趨近於團隊成員對程式碼產出的要求。

1. Automatically run cleanup on file save

「Automatically run cleanup on file save」:位於Cleaning->General設定頁面。當該選項設定為勾選時,會在檔案存檔的同時,自動執行程式碼排版功能。

2. Run remove unused using statements

「Run remove unused using statements」:位於Cleaning->Visual Studio設定頁面。當該選項設定為勾選時,會在執行程式碼排版功能時,移除沒有使用的using定義。(開發階段建議不要勾選該選項,因為移除未使用的using定義,會造成使用LINQ時找不到擴充方法的問題。)

3. Remove multple consecutive blank lines

「Remove multple consecutive blank lines」:位於Cleaning->Remove設定頁面。當該選項設定為勾選時,會在執行程式碼排版功能時,移除連續多行的空白行。

4. Update #endregion tag with region name

「Update #endregion tag with region name」:位於Cleaning->Updae設定頁面。當該選項設定為勾選時,會在執行程式碼排版功能時,為#endregion區域標籤加上區域名稱。

5. Alphabetize members of the same group

「Alphabetize members of the same group」:位於Reorganizing->General設定頁面。當該選項設定為勾選時,會在執行程式碼排版功能時,依照成員類型排序之後,增加依照字母順序排序的工作項目。

參考資料

[Tool] 使用CodeMaid自動程式排版 - 摘自网络的更多相关文章

  1. [Tool] 使用CodeMaid自动程序排版

    [Tool] 使用CodeMaid自动程序排版 前言 「使用StyleCop验证命名规则」这篇文章,指引开发人员透过StyleCop这个工具,来自动检验项目中产出的程序代码是否合乎命名规则. [Too ...

  2. Android:控件WebView显示网页 -摘自网络

    WebView可以使得网页轻松的内嵌到app里,还可以直接跟js相互调用. webview有两个方法:setWebChromeClient 和 setWebClient setWebClient:主要 ...

  3. C# 中的内存管理,摘自网络

    C#编程的一个优点是程序员不需要关心具体的内存管理,尤其是垃圾收集器会处理所有的内存清理工作.虽然不必手工管理内存,但如果要编写高质量的代码,还是要理解后台发生的事情,理解C#的内存管理.本文主要介绍 ...

  4. Ubuntu的常用快捷键(摘自网络)

    篇一 : Ubuntu的复制粘贴操作及常用快捷键(摘自网络) Ubuntu的复制粘贴操作 1.最为简单,最为常用的应该是鼠标右键操作了,可以选中文件,字符等,右键鼠标,复制,到目的地右键鼠标,粘贴就结 ...

  5. SQL Server Data Tool 嘹解(了解)一下 SSDT -摘自网络

    Visual Studio 2010 的伺服器管理員可以用來連接 Sharepoint.伺服器,還可以透過資料連接連結至 SQL Server  等資料來源.以資料來源為例,您可以利用單一工具(Vis ...

  6. Scott Hanselman's 2014 Ultimate Developer and Power Users Tool List for Windows -摘自网络

    Everyone collects utilities, and most folks have a list of a few that they feel are indispensable.  ...

  7. 利用XSD配合XSLT產出特定格式Word檔案 -摘自网络

    利用類別產生XSD檔 產出XSD檔的目的在於提供Word樣板設計之資料框架 在此使用微軟提供之XML Schema Definition Tool (Xsd.exe)工具產生XSD檔 1. 定義類別 ...

  8. 使用 NodeJS + Express 從 GET/POST Request 取值 -摘自网络

    過去無論哪一種網站應用程式的開發語言,初學者教學中第一次會提到的起手式,八九不離十就是 GET/POST Request 的取值.但是,在 Node.js + Express 的世界中,彷彿人人是高手 ...

  9. 理解OAuth 2.0 -摘自网络

    OAuth是一个关于授权(authorization)的开放网络标准,在全世界得到广泛应用,目前的版本是2.0版.                                      本文对OA ...

随机推荐

  1. fiddler 插件开发二

    本篇主要讲解Fildder插件开发中的涉及到的主要接口与类. 1.IFiddlerExtension 接口 如果要开发的自定义插件有UI界面,则需要实现IFiddlerExtension 接口.你程序 ...

  2. C++11新特性:右值引用和转移构造函数

    问题背景 #include <iostream> using namespace std; vector<int> doubleValues (const vector< ...

  3. php采集远程文章简单类

    <?php /** * 采集类 * @author Milkcy * @copyright (C) 2012-2015 TCCMS.COM * @lastmodify 2012-07-10 14 ...

  4. URAL 1146 Maximum Sum & HDU 1081 To The Max (DP)

    点我看题目 题意 : 给你一个n*n的矩阵,让你找一个子矩阵要求和最大. 思路 : 这个题都看了好多天了,一直不会做,今天娅楠美女给讲了,要转化成一维的,也就是说每一列存的是前几列的和,也就是说 0 ...

  5. 在XML里的XSD和DTD以及standalone的使用2----具体使用详解

    如何定义XSD并在XML中使用XSD 同时XSD可以对XML中的格式进行约束,当约束失败时给出提示. 下面以下使用VS2010为平台进行演示. 1.新建一个项目,然后在项目中添加xml架构文件(.xs ...

  6. window的cmd窗口运行git

    般情况下,我们在 Window 下安装好 git 后,在运行里面打开 cmd 窗口,在里面直接运行 git --version ,会提示“不是内部或外部命令,也不是一个可运行的程序”. 要想在cmd窗 ...

  7. asp mvc 路由

    public override void RegisterArea(AreaRegistrationContext context) { context.MapRoute( "Workflo ...

  8. knockout 绑定 jquery ui datepicker (转)

    ko.bindingHandlers.datepicker = { init: function(element, valueAccessor, allBindingsAccessor) { //in ...

  9. bzoj列表2

    之前发过一次了,这里的题较水,没什么好讲的 bzoj1088 直接穷举前两位即可,话说程序员的扫雷是白玩的? bzoj1083 裸的最小生成树(最小生成树=最小瓶颈树),SCOI大丈夫(话说网上二分是 ...

  10. Javascript获取最近若干个月

    整理: 如果需要获取最近若干个月,牵扯到跨年的话,该怎么实现的问题,抽了点时间,代码如下: /**纪元时间获取最近12个月 * * @num 传入获取月的数目 **/ (function getMon ...