Visual Studio 2008中FormatX源代码格式化插件
原地址:http://www.cr173.com/html/15492_1.html
我总是对组里的兄弟代码规范性近乎完美的要求,举个简单的例子:
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