docs: Add standard Javadoc comments to all Java source files

2026-07-09 09:11:46 +09:00
parent 69d7a7bff0
commit 5e4f88ea41
147 changed files with 2259 additions and 115 deletions
--- a/AddJavadoc.java
+++ b/AddJavadoc.java
@@ -0,0 +1,103 @@
+import java.io.*;
+import java.nio.file.*;
+import java.nio.file.attribute.BasicFileAttributes;
+import java.util.*;
+import java.util.regex.*;
+
+public class AddJavadoc {
+
+    static final String ROOT_DIR = ".";
+    
+    static final String TEMPLATE = 
+        "/**\n" +
+        " * @package %s\n" +
+        " * @className %s\n" +
+        " * @description AX HUB 시스템 처리 클래스\n" +
+        " * @author 김형식\n" +
+        " * @create 2026.09.01\n" +
+        " * <pre>\n" +
+        " * ---------- 개정이력 ----------\n" +
+        " * 수정일      수정자    수정내용\n" +
+        " * ---------- -------- ---------------------------\n" +
+        " * 2026.09.01  김형식    최초생성\n" +
+        " * \n" +
+        " * </pre>\n" +
+        " */";
+
+    public static void main(String[] args) throws Exception {
+        Files.walkFileTree(Paths.get(ROOT_DIR), new SimpleFileVisitor<Path>() {
+            @Override
+            public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) {
+                String name = dir.getFileName().toString();
+                if (name.equals(".git") || name.equals("build") || name.equals(".gradle") || name.equals("scratch") || name.equals("out") || name.equals("bin")) {
+                    return FileVisitResult.SKIP_SUBTREE;
+                }
+                return FileVisitResult.CONTINUE;
+            }
+
+            @Override
+            public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+                if (file.toString().endsWith(".java") && !file.getFileName().toString().equals("AddJavadoc.java")) {
+                    processJavaFile(file);
+                }
+                return FileVisitResult.CONTINUE;
+            }
+        });
+        System.out.println("Done.");
+    }
+
+    private static void processJavaFile(Path file) throws IOException {
+        List<String> lines = Files.readAllLines(file);
+        String content = String.join("\n", lines);
+        
+        if (content.contains("---------- 개정이력 ----------") || content.contains("@className")) {
+            System.out.println("Skipping (already has javadoc): " + file);
+            return;
+        }
+
+        String packageName = "unknown";
+        String className = "unknown";
+
+        Matcher pkgMatcher = Pattern.compile("(?m)^\\s*package\\s+([\\w\\.]+)\\s*;").matcher(content);
+        if (pkgMatcher.find()) {
+            packageName = pkgMatcher.group(1);
+        }
+
+        int classDeclIdx = -1;
+        for (int i = 0; i < lines.size(); i++) {
+            String line = lines.get(i);
+            Matcher classMatcher = Pattern.compile("^\\s*(?:public\\s+|protected\\s+|private\\s+|abstract\\s+|final\\s+|static\\s+)*(class|interface|enum|record)\\s+(\\w+)").matcher(line);
+            if (classMatcher.find()) {
+                classDeclIdx = i;
+                className = classMatcher.group(2);
+                break;
+            }
+        }
+
+        if (classDeclIdx == -1) {
+            System.out.println("Skipping (no class declaration found): " + file);
+            return;
+        }
+
+        int insertIdx = classDeclIdx;
+        for (int i = classDeclIdx - 1; i >= 0; i--) {
+            String line = lines.get(i).trim();
+            if (line.isEmpty()) {
+                continue;
+            }
+            if (line.startsWith("@")) {
+                insertIdx = i;
+            } else if (line.startsWith("//") || line.startsWith("/*") || line.startsWith("*")) {
+                break;
+            } else {
+                break;
+            }
+        }
+
+        String javadoc = String.format(TEMPLATE, packageName, className);
+        lines.add(insertIdx, javadoc);
+
+        Files.write(file, String.join("\n", lines).getBytes("UTF-8"));
+        System.out.println("Updated: " + file);
+    }
+}