在Visual Studio中批量添加文件头注释

有些代码规范要求开发人员在代码文件的头部编写注释,大体内容为这个文件的作用,创建日期以及创建者,更甚者还要包含每次修改的备注等等详细记录。虽然我个人认为在有着诸如TFS这样优秀的源代码管理工具的今天,只要代码可读性足够好,这种注释完全没有必要。但倘若项目进行到一个阶段,突然要求补加文件头注释,有什么比较快捷的方法呢,稍微研究了一下,找到一个不甚严谨但快速实用的方法,在此记录一下。

在Visual Studio里解决这个问题非常简单,使用“查找与替换”命令即可,我们需要做的仅仅是想办法能让替换功能仅仅定位到文件的开始位置。

好在Visual Studio的“查找与替换”是支持增则表达式的,而且基本上所有C#类文件都是以using语句开头的,所以我们可以用下面这行代码来定位到文件的开始位置:

(?<!\r\n)(?<!\s)using

其中using前边的两对括号是两个“否定逆序环视”结构,表示using前边不可以是换行符或者空白符,这样就可以仅仅定位到第一个using语句,而不会包含其余的using语句以及代码中的using语句块。

接下来是要替换的部分,由于Visual Studio只支持单行替换,所以我们需要把多行的注释内容用\r\n排版为一行,同时不要忘了在末尾加上\r\nusing,否则第一个using语句就被破坏了,如下所示:

/*\r\n********************************************************************************\r\n*\r\n*    Project           Some Project\r\n*    Module Name       SharePoint UI\r\n*    Author            Name (Email)\r\n*    Creation Date     mm/dd/yyyy\r\n*    Description       Description\r\n*\r\n*    © Copyright 2012 Some Company, L.P.\r\n*\r\n********************************************************************************\r\n*/\r\nusing

此时的“查找和替换”对话框应该是这个样子的:

点击“全部替换”后,就会发现所有的代码文件头部都有了如下的注释:

然后逐个修改一下Author,Creation Date和Description等与文件相关的信息即可。

发表评论

电子邮件地址不会被公开。 必填项已用*标注