可插入注释处理器 API 可以检索源代码注释吗？

Question

我正在使用 Java6+ 的可插入注释处理 api 自动创建一些部署 XML 文件。这些 XML 文件的一部分包含对象的描述。描述始终与与类本身关联的 Javadoc 内容相同。我可以强制注释成为 @Block 注释的字段，但这会重复信息。在注释处理期间有什么方法可以获取类/类型注释的内容吗？

在这个例子中，我想在注释处理期间获得“我的块的一个很好的描述”。

/**
* A nice description of my block
**/
@Block
public class CustomBlock {
}

Answer 1

我似乎总是在发布 SO 后立即找到答案。

供以后参考，这是解决方案

import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.TypeElement;

public class CustomAnnotationProcessor extends AbstractProcessor
{
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment re)
    {
 
        // use the protected member, processingEnv
        
        String comment = processingEnv.getElementUtils().getDocComment(anyElement);
    }
}

Answer 2

有 getDocComment 听起来应该返回评论。

更新：它已移至 元素实用程序。

Answer 3

注释处理 API 使用 javax.lang.model(.*) 包中的类。这些模型语言构造和所述模型必须在编译期间生成。由于编译器旨在忽略注释和文档，因此这些包中似乎没有任何内容（我也不希望有任何内容）可以让您访问注释/文档。

我不确定 javadoc 工具如何执行其工作，也许这会有所帮助。

Kapep 的答案看起来很有趣，但请注意它使用了 com.sun.* 包中的内容，这是特定于实现的。除非您完全确定提供给注释处理器环境的资源是使用这些类实现的，并且您可以安全地从接口向下转换，否则最好不要使用它。这充其量只是一个脆弱的解决方案。

编辑：顺便说一句，我还使用自定义注释+处理器来生成 XML 格式的元数据，用于接线、验证等。而且我还需要描述。因此，我所做的就是保留 JavaDoc 用于编程目的和在代码中直接使用该类的人可能感兴趣的详细信息，同时在注释中包含一些描述键（或者基于类名/其他注释值的默认值，如果没有给出） ）可用于从某些资源文件中获取描述。该描述面向“最终用户”，重点关注高级内容，而不是代码细节。它还有促进国际化的额外好处。我不确定这对你有什么用，但这是我的两分钱。