首页 > 解决方案 > 使用 Spoon 在文档注释中获取非 Javadoc 标记的文本

问题描述

我想使用 inria-spoon 来处理在文档注释中具有自定义非 Javadoc 标记的 Java 源文件。但是,当 Spoon 处理 Doc 注释时,String返回的 usingCtMethod#getDocComment()会将非 Javadoc 标记的文本替换为@unknown. 我需要保留标签的原始文本以供进一步过滤和处理。

下面的两个类显示了一个示例,其中输出为

@unknown some-value
@return name of husband

并且想要的是

@abc:xyz some-value
@return name of husband

运行的主要方法是类Spooner,正在处理的源是Carrie.java

Spooner.java

package tryspoon;

import spoon.Launcher;
import spoon.reflect.declaration.CtMethod;
import spoon.reflect.visitor.filter.TypeFilter;

public class Spooner
{
    private static final String SAMPLE_SOURCE_PATH = "full_local_path_to_source";


    public static void main(String[] args)
    {
        Launcher launcher = new Launcher();
        launcher.addInputResource(SAMPLE_SOURCE_PATH);
        launcher.buildModel();

        String firstDocComment = launcher.getModel()
          .getElements(new TypeFilter<>(CtMethod.class))
          .get(0).getDocComment();

        System.out.println("First Doc comment contents: " + firstDocComment);

    }
}

Carrie.java

package tryspoon;

public class Carrie {
  /**
   * @abc:xyz some-value
   * @return name of husband
   */
  public String husband()
  {
    return "Doug";
  }
}

标签: javajavadocinria-spoon

解决方案


当https://github.com/INRIA/spoon/pull/3513合并时,这将很快在 master 中修复。


推荐阅读