利用Eclipse JDT ASTRewrite添加注释

最新推荐文章于 2024-09-03 08:39:52 发布

飘_落

最新推荐文章于 2024-09-03 08:39:52 发布

阅读量785

点赞数 1

文章标签： eclipse jdt ast java

本文介绍了一种在Java代码中指定位置自动插入注释的方法。通过使用Eclipse JDT AST API，该方法能够准确地定位到需要添加注释的位置，并进行插入操作。此过程涉及到AST树的解析、创建及编辑等步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、修改前

public class Main {
    public static void main(String[] args) {
        int i = 1;
        System.out.println(i);
    }
    public static void add() {
        int i = 1;
        System.out.println(i);
    }
}

2、修改后

public class Main {
    public static void main(String[] args) {
        //mycomment
        int i = 1;
        System.out.println(i);
    }
    public static void add() {
        int i = 1;
        System.out.println(i);
    }
}

3、源码

private void AddComments() throws MalformedTreeException, BadLocationException, CoreException {

    IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject("testAddComments");
    IJavaProject javaProject = JavaCore.create(project);
    IPackageFragment package1 = javaProject.getPackageFragments()[0];

    //get first compilation unit
    ICompilationUnit unit = package1.getCompilationUnits()[0];

    // parse compilation unit
    CompilationUnit astRoot = parse(unit);

    //create a ASTRewrite
    AST ast = astRoot.getAST();
    ASTRewrite rewriter = ASTRewrite.create(ast);

    //for getting insertion position
    TypeDeclaration typeDecl = (TypeDeclaration) astRoot.types().get(0);
    MethodDeclaration methodDecl = typeDecl.getMethods()[0];
    Block block = methodDecl.getBody();

    ListRewrite listRewrite = rewriter.getListRewrite(block, Block.STATEMENTS_PROPERTY);
    Statement placeHolder = (Statement) rewriter.createStringPlaceholder("//mycomment", ASTNode.EMPTY_STATEMENT);
    listRewrite.insertFirst(placeHolder, null);

    TextEdit edits = rewriter.rewriteAST();

    // apply the text edits to the compilation unit
    Document document = new Document(unit.getSource());

    edits.apply(document);

    // this is the code for adding statements
    unit.getBuffer().setContents(document.get());

    System.out.println("done");
}