kconfig-core/club.skidware.kconfig.annotation/Comment

Comment

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class Comment(val lines: String, val placement: CommentPlacement = CommentPlacement.ABOVE)

Marks a configuration field with a descriptive comment that will be written into the YAML output.

Comments improve readability for administrators editing config files manually. Supports both above-line and inline placement strategies via CommentPlacement. Multiple lines can be provided, each rendered as a separate comment line.

Usage:

data class ServerConfig(
    @Comment("The unique identifier for this server instance")
    val serverId: String = "lobby01",

    @Comment("Maximum concurrent players", placement = CommentPlacement.INLINE)
    val maxPlayers: Int = 200,

    @Comment("Enable debug logging", "Warning: generates verbose output")
    val debug: Boolean = false
)
Content copied to clipboard

Since

1.0

See also

Properties

Link copied to clipboard
val lines: Array<out String>

One or more comment lines to include in the YAML output.

Link copied to clipboard
val placement: CommentPlacement

Controls whether the comment appears above the field or inline. Defaults to CommentPlacement.ABOVE.