net.openhft.chronicle.wire

Annotation Type Comment

@Retention(value=RUNTIME)
 @Target(value={FIELD,PARAMETER,TYPE})
public @interface Comment

The Comment annotation represents a way to attach user-defined comments to elements like fields, parameters, or types. This can be especially useful for documenting the intention, usage, or any other relevant information about the annotated element at runtime.

Being retained at runtime, it can be inspected via reflection to influence behavior based on the comment's content.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Returns the comment content as a string.

Element Detail

value

public abstract String value

Returns the comment content as a string.

Returns:

The comment content associated with the annotated element.