添加代码作者、日期信息
近期公司项目代码核查,要求添加署名注释,以便代码追责,由于编码习惯、合作开发等各种原因,老项目代码作者信息混乱,自己写了个工具类,递归目录查询java相关的文件,添加作者和日期信息,上代码:
package com.util;
import java.io.*;
public class FileHeaderUtil {
public static void add(String path, String authName,String date) {
File dir = new File(path);
File[] files = dir.listFiles();
for (File file : files) {
try {
if (file.isDirectory()) {
add(file.getCanonicalPath(), authName,date);
} else if (file.getName().endsWith(".java")) {
BufferedReader br = new BufferedReader(new FileReader(file));
StringBuilder content = new StringBuilder();
String strLine;
boolean flag = false;
boolean nextFlag = true;
while ((strLine = br.readLine()) != null) {
if (nextFlag && (strLine.matches("^@.*") || strLine.matches("^public.*[{]"))) {
content.append("/**\n" +
" * Created by " + authName + " on "+date+"\n" +
" */\n");
nextFlag = false;
}else if (strLine.matches(".*\\*.*\\d{4}[-/]\\d+[-/]\\d+.*")) {
flag = true;
break;
}
content.append(strLine+"\n");
}
if (flag) {
continue;
}
BufferedWriter bw = new BufferedWriter(new FileWriter(file));
bw.write(content.toString());
bw.flush();
}
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
工具类自己就没添加签名了,顺便测试下效果,署名信息模板可根据代码自定义,代码忽略已有签名(条件包含日期)的java文件,运行测试代码,参数:项目目录,作者信息,日期
package com.util;
public class Test {
public static void main(String[] args) {
FileHeaderUtil.add("F:\\projects\\test","varCode","2019/4/30");
}
}
测试效果,直接查看写的工具类和测试类: