当前位置:   article > 正文

添加注释作者信息_代码作者注释

代码作者注释

添加代码作者、日期信息
近期公司项目代码核查,要求添加署名注释,以便代码追责,由于编码习惯、合作开发等各种原因,老项目代码作者信息混乱,自己写了个工具类,递归目录查询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();
            }
        }
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44

工具类自己就没添加签名了,顺便测试下效果,署名信息模板可根据代码自定义,代码忽略已有签名(条件包含日期)的java文件,运行测试代码,参数:项目目录,作者信息,日期

package com.util;

public class Test {
    public static void main(String[] args) {
        FileHeaderUtil.add("F:\\projects\\test","varCode","2019/4/30");
    }
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

测试效果,直接查看写的工具类和测试类:
在这里插入图片描述
在这里插入图片描述

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/繁依Fanyi0/article/detail/326571
推荐阅读
相关标签
  

闽ICP备14008679号