如何使用CodeMaid自動(dòng)程序排版

這篇文章將為大家詳細(xì)講解有關(guān)如何使用CodeMaid自動(dòng)程序排版,文章內(nèi)容質(zhì)量較高,因此小編分享給大家做個(gè)參考,希望大家閱讀完這篇文章后對(duì)相關(guān)知識(shí)有一定的了解。

網(wǎng)站建設(shè)公司,為您提供網(wǎng)站建設(shè),網(wǎng)站制作,網(wǎng)頁(yè)設(shè)計(jì)及定制網(wǎng)站建設(shè)服務(wù),專注于企業(yè)網(wǎng)站設(shè)計(jì),高端網(wǎng)頁(yè)制作,對(duì)成都紗窗等多個(gè)行業(yè)擁有豐富的網(wǎng)站建設(shè)經(jīng)驗(yàn)的網(wǎng)站建設(shè)公司。專業(yè)網(wǎng)站設(shè)計(jì),網(wǎng)站優(yōu)化推廣哪家好,專業(yè)營(yíng)銷(xiāo)推廣優(yōu)化,H5建站,響應(yīng)式網(wǎng)站。

在項(xiàng)目開(kāi)發(fā)的過(guò)程中,如果只是驗(yàn)證命名規(guī)則、而沒(méi)有統(tǒng)一程序排版,項(xiàng)目中很容易就會(huì)出現(xiàn)類似下列范例的程序代碼產(chǎn)出。這樣的產(chǎn)出,雖然能夠正常地提供項(xiàng)目功能、并且符合微軟的命名規(guī)則,但是因?yàn)槌绦蚺虐媪鑱y的問(wèn)題,大幅降低了這份程序代碼的可維護(hù)性。

  • 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;
    }

本篇文章介紹如何透過(guò)CodeMaid這個(gè)工具,來(lái)自動(dòng)整理項(xiàng)目中程序代碼的排版,在不增加開(kāi)發(fā)人員負(fù)擔(dān)的前提下,讓團(tuán)隊(duì)的程序代碼產(chǎn)出趨于一致、大幅提高程序代碼的生產(chǎn)質(zhì)量。主要為自己留個(gè)紀(jì)錄,也希望能幫助到有需要的開(kāi)發(fā)人員。

  • 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. 首先至微軟的官方網(wǎng)站,下載CodeMaid安裝檔:「CodeMaid_v0.7.4.vsix」。

    如何使用CodeMaid自動(dòng)程序排版

    • http://visualstudiogallery.msdn.microsoft.com/76293c4d-8c16-4f4a-aee6-21f83a571496

  2. 執(zhí)行CodeMaid安裝檔:「CodeMaid_v0.7.4.vsix」,來(lái)安裝CodeMaid。

    如何使用CodeMaid自動(dòng)程序排版

執(zhí)行

  1. 使用Visual Studio開(kāi)啟項(xiàng)目。

    如何使用CodeMaid自動(dòng)程序排版

  2. Visual Studio上方工具欄中,開(kāi)啟CODEMAID選單、點(diǎn)選Configuration來(lái)開(kāi)啟CodeMaid設(shè)定畫(huà)面。

    如何使用CodeMaid自動(dòng)程序排版

  3. CodeMaid設(shè)定畫(huà)面中,進(jìn)入Reorganizing->General設(shè)定頁(yè)面,勾選「Run organize at start cleanup」后,點(diǎn)擊Save按鈕完成設(shè)定。

    如何使用CodeMaid自動(dòng)程序排版

  4. 后續(xù)就可以從Visual Studio上方工具欄中,開(kāi)啟CODEMAID選單、點(diǎn)選「Cleanup all Code」來(lái)自動(dòng)排版項(xiàng)目?jī)?nèi)的所有程序代碼。

    如何使用CodeMaid自動(dòng)程序排版

  5. 自動(dòng)排版功能執(zhí)行結(jié)束之后,開(kāi)啟項(xiàng)目?jī)?nèi)的程序代碼,會(huì)發(fā)現(xiàn)程序代碼內(nèi)容已經(jīng)排列整齊、干凈,大幅提高程序代碼的可維護(hù)性。

    如何使用CodeMaid自動(dòng)程序排版

延伸

CodeMaid所提供的程序代碼自動(dòng)排版功能,用起來(lái)很方便、排版結(jié)果也很簡(jiǎn)潔。但是在一些細(xì)節(jié)上,總是會(huì)有些許的排版定義,不符合團(tuán)隊(duì)成員對(duì)于程序代碼質(zhì)量的要求。不過(guò)還好的是,CodeMaid開(kāi)放了許多排版條件的設(shè)定項(xiàng)目,讓開(kāi)發(fā)人員可以調(diào)整排版條件,來(lái)讓排版結(jié)果趨近于團(tuán)隊(duì)成員對(duì)程序代碼產(chǎn)出的要求。

1. Automatically run cleanup on file save

「Automatically run cleanup on file save」:位于Cleaning->General設(shè)定頁(yè)面。當(dāng)該選項(xiàng)設(shè)定為勾選時(shí),會(huì)在檔案存盤(pán)的同時(shí),自動(dòng)執(zhí)行程序代碼排版功能。

2. Run remove unused using statements

「Run remove unused using statements」:位于Cleaning->Visual Studio設(shè)定頁(yè)面。當(dāng)該選項(xiàng)設(shè)定為勾選時(shí),會(huì)在執(zhí)行程序代碼排版功能時(shí),移除沒(méi)有使用的using定義。(開(kāi)發(fā)階段建議不要勾選該選項(xiàng),因?yàn)橐瞥词褂玫膗sing定義,會(huì)造成使用LINQ時(shí)找不到擴(kuò)充方法的問(wèn)題。)

3. Remove multple consecutive blank lines

「Remove multple consecutive blank lines」:位于Cleaning->Remove設(shè)定頁(yè)面。當(dāng)該選項(xiàng)設(shè)定為勾選時(shí),會(huì)在執(zhí)行程序代碼排版功能時(shí),移除連續(xù)多行的空白行。

4. Update #endregion tag with region name

「Update #endregion tag with region name」:位于Cleaning->Updae設(shè)定頁(yè)面。當(dāng)該選項(xiàng)設(shè)定為勾選時(shí),會(huì)在執(zhí)行程序代碼排版功能時(shí),為#endregion區(qū)域卷標(biāo)加上區(qū)域名稱。

5. Alphabetize members of the same group

「Alphabetize members of the same group」:位于Reorganizing->General設(shè)定頁(yè)面。當(dāng)該選項(xiàng)設(shè)定為勾選時(shí),會(huì)在執(zhí)行程序代碼排版功能時(shí),依照成員類型排序之后,增加依照字母順序排序的工作項(xiàng)目。

關(guān)于如何使用CodeMaid自動(dòng)程序排版就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò),可以把它分享出去讓更多的人看到。

本文題目:如何使用CodeMaid自動(dòng)程序排版
網(wǎng)址分享:http://bm7419.com/article6/pdhsig.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供企業(yè)網(wǎng)站制作、、ChatGPT自適應(yīng)網(wǎng)站、定制網(wǎng)站、網(wǎng)站排名

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)

成都網(wǎng)站建設(shè)公司