如何評論（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

我用來將Query的名稱定義為實體類內部的常量。 那個常數當然可以評論：

@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";

   ...
}

作為獎勵，您可以在創建命名查詢時使用此常量而不是String：

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