Description
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD] )
Provides a human-readable description for annotated elements.
This annotation is used to add descriptive text that can be used for:
API documentation generation
User interface labels
Logging and monitoring
Development tools and IDE support
The description should be clear, concise, and provide meaningful context about the purpose and usage of the annotated element.
Example usage:
@Description("Represents a customer order in the e-commerce system")
data class Order(
@Description("Unique identifier for the order")
val orderId: String,
@Description("Total monetary value of the order including taxes and shipping")
val totalAmount: BigDecimal
)Content copied to clipboard
Parameters
value
The description text. Should be a complete, grammatically correct sentence or phrase.
See also
for shorter, concise descriptions