如何评论 (javadoc) NamedQueries

Question

假设一个实体中有一些命名查询，这些命名查询应该如何评论？有没有办法将它们映射到创建的 javadoc 中？

  @Entity
    @NamedQueries({
        @NamedQuery(name="Country.findAll",
                    query="SELECT c FROM Country c"),
        @NamedQuery(name="Country.findByName",
                    query="SELECT c FROM Country c WHERE c.name = :name"),
    }) 
    public class Country {
      ...
    }

目前我在之前的行中添加了注释（非 javadoc），但我不太喜欢它。

// find all countries
@NamedQuery(name="Country.findAll", query="SELECT c FROM Country c")

Answer 1

我用来将查询的名称定义为实体内部的常量class。该常数当然可以注释：

@Entity
@NamedQueries({
@NamedQuery(name=Country.QUERY_FIND_BY_NAME,
            query="SELECT c FROM Country c WHERE c.name = :name"),
}) 
public class Country {

    /**
     * Description of the Query. Bla bla.
     */
    public static final String QUERY_FIND_BY_NAME = "Country.findByName";

   ...
}

作为奖励，您可以在创建命名查询时使用此常量而不是字符串：

em.createNamedQuery(Country.QUERY_FIND_BY_NAME, Country.class);

如何评论 (javadoc) NamedQueries

How to comment (javadoc) NamedQueries

java

jpa

named-query