前言
行尾注释写起来比较方便,所以很多时候我们都会习惯把注释写在行尾。
但这个是不符合编程规范的,写的代码注释主要是给后续接手人进行阅读帮助的。按照正常的阅读方式都是先读注释,然后再看代码,如果先看代码再看注释,就会影响阅读的流畅。
一般接手项目都是半途接手的,而且这个规范约束算是弱约束,所以即使在工作中出现了也不会有大的影响。所以这种问题就会慢慢的累积,超过了盛夏的果实。到后面进行规约扫描的时候,基本上都是4位数。
有代码洁癖,肯定是受不了的。怎么办?改呗,改的话又没有技术含量,也比较耗费时间。所以改起来基本上断断续续。
有没有快速的方法呢?这个还真是有!
用IDEA的正则表达式替换功能,可以批量进行替换,尝试了一下,基本上没啥问题。
IDEA正则替换
这就上手干
1、直接在项目根目录,右键点击->选择“在文件中替换(A)...”
2、在弹出的框中,输入正则表达式,并且选择正则匹配
^(\s *)//(.*)$ 这个主要是进行行匹配。()里面就是后续参数$1 $2(按照顺序排序)
3、输入替换方式
$1/*$3*/
$1$2
说明 :$1代表第一个参数,$2代表第二个参数;$3代表第三个参数;/* */原样输出。
4、直接点击下面的“替换”按钮就可以,如果代码没啥问题,可以选择“替换全部”
示例效果
以 out.flush();// 定义BufferedReader输入流 这行替换为例。
源代码样式
out.flush();// 定义BufferedReader输入流
替换后代码样式如下:
/*定义BufferedReader输入流*/
out.flush();
$1为前面的空格部分;$2为代码部分;$3为注释部分;
说明
可以不用$1,但是不用的话,$3就不能无法和代码行对齐。用过IDEA进行代码格式化的都知道,注释行格式化操作的时候,是不会自动缩进的,这样影响了阅读的流程,所以在这里增加了$1。