FormatX源代碼格式化插件


起因

去年在廣州的時候,我總是對組里的兄弟代碼規范性近乎完美的要求,舉個簡單的例子:

1、  每個方法必須有注釋,方法參數詳細說明

2、  第個方法、事件、函數必須具有統一的可折疊代碼塊

3、  每個屬性以及枚舉必須具有單獨的注釋和說明

 

      對於程序員來說,這基本算是個惡夢,重要的參數注明就可以了,沒必要全部都寫(我也時常這樣安慰自己),但最后發現其實真是一來自己懶二來非常的煩瑣,雖然可以通過自定義文本工具來拖拽式生產,但始終是苦力啊。

於是乎這兩天閑來無事就有了這個插件,用了以后誰再說你的代碼不漂亮你跟我急。我負責面壁好了。

 

主要功能

 

閑話少說,插件主要有下面的一些小功能(磚頭神馬的扔來,最近蓋房急需,哈哈)

自動識別namespace , class , struct , enum , property ,方法和函數以及事件(以下統一稱為Function)統一被識別為Function,但方法名保持不變。

自動識別嵌套類、結構等等。

自動識別Function中的參數並自動生成參數的xml化注釋,但是這里有一個BUG,不能識別Function返回值。

自動為 class , struct , enum , property , Function添加#region #endregion折疊代碼塊。

自動判斷Property 和 Function 類型來生成注釋,如Property的注釋以“獲取或者設置 ”開頭。

 

先來張對比圖

 

自動識別重載方法

 

使用方法

下載本插件dll和引導文件,解壓縮后將FormatX.dll和FormatX.AddIn放入C:\Users\[UserName]\Documents\Visual Studio 2008\Addins 文件夾(推薦設置),特別是windows7下無法找到Document and Setting文件夾的情況下(也是安全性考慮),將插件放入

文件夾中,對應的文件夾一般是:C:\Users\[UserName]\Documents\Visual Studio 2008\Addins,這可能會由於visual studio版本不同而路徑不一,但總體來說應該是一致的。或者在visual studio中將外部連接添加到visual studio中(不推薦)

 

關於外接程序和安全性,MSDN上有專門的解釋,不推薦添加外部插件鏈接,具體參考這里:

http://technet.microsoft.com/zh-cn/library/1326zbk3%28v=vs.90%29

以上設置完成后,打開visual studio,將會看到主菜單上多了一個FormatX按鈕

 

打開工具>外接程序管理器

 

可以看到插件已添加到visual studio里。現在打開你的項目,爽一下吧。

插件下載:FormatX.rar


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM