@Target ({TYPE ,FIELD ,METHOD })
@Retention (RUNTIME )
public @interface Description
Annotation that describes an element by using a sentence or two.
Use sentence-style capitalization, capitalize the first letter of the first
word, and any proper names such as the word Java. If the description is one
sentence, a period should not be included.
Since:
9
Required Element Summary
Required Elements
Modifier and Type
Required Element
Description
String
value
Returns a sentence or two that describes the annotated element.
Element Details
value
Returns a sentence or two that describes the annotated element.
Returns:
a description, not null
Java SE 15 & JDK 15 DRAFT 15-internal+0-adhoc.jjg.open
Report a bug or suggest an enhancement For further API reference and developer documentation see the Java SE Documentation , which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries. Copyright © 1993, 2020, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA. All rights reserved. Use is subject to license terms and the documentation redistribution policy . DRAFT 15-internal+0-adhoc.jjg.open