Как прокомментировать (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

Используется для определения имени запроса как константы внутри класса сущности. Это константа, конечно, может быть прокомментированы:

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