json5k/io.github.xn32.json5k/SerialComment

SerialComment

@Target(allowedTargets = [AnnotationTarget.PROPERTY])
@SerialInfo
annotation class SerialComment(val value: String)(source)

Annotation to specify a comment that should be serialized to every JSON5 occurrence of a property.

When this annotation is applied to a property and human-readable JSON5 output is generated, every member of a generated JSON5 object that represents this property will be preceded by a JSON5 representation of this comment.

Properties

Link copied to clipboard
val value: String

Comment to generate whenever the property is serialized into a JSON5 object. This value will be trimmed using the String.trimIndent function of Kotlin. Multi-line strings (separated by any of the JSON5 line terminators) are supported.