Package org.hibernate.annotations
Annotation Interface Comment
@Target({METHOD,FIELD,TYPE})@Retention(RUNTIME)@Repeatable(Comments.class)@Deprecated(since="7")@Removepublic @interfaceComment
Deprecated.
Prefer
Table.comment(),Column.comment(), etc.Specifies a comment that will be included in generated DDL.
By default, ifon() isnot specified:
- when a field or property is annotated, the comment applies to the mapped column,
- when a collection is annotated, the comment applies to the collection table, and
- when an entity class is annotated, the comment applies to the primary table.
But whenon() is explicitly specified, the comment applies to the mapped table or column with the specified name.
For example:
@Entity @Table(name = "book") @SecondaryTable(name = "edition") @Comment("The primary table for Book") @Comment(on = "edition", value = "The secondary table for Book") class Book { ... }- API Note:
- In principle, it's possible for a column of a secondary table to have the same name as a column of the primary table, or as a column of some other secondary table. Therefore,
on()may be ambiguous.
Required Element Summary
Required ElementsOptional Element Summary
Optional Elements