描述
Translation status: 简体中文 reader-locale proof. Term names and code fences follow the zh-Hans pack; supporting prose may still be English.
Attaches a description string to CLI metadata.
Syntax: @ 描述 <string>
Category#
cli
Related#
Examples#
radix/corpus/descriptio/descriptio.fab (canonical · keyword)#
Attaches a description string to CLI metadata.
# =============================================================================
# 描述 — Attaches a description string to CLI metadata.
# =============================================================================
#
# What this teaches:
# • CLI metadata — `@ 描述 <string>` attaches a human-readable description to a CLI command's metadata.
# • Annotation syntax — used together with `@ cli` to annotate entry points with metadata for CLI generation.
#
# Common mistakes:
# • Using 描述 without a corresponding @cli annotation — `@ 描述` only has meaning when attached to a `@ cli` entry point.
#
# See also: versio
# =============================================================================
# 描述 — CLI description annotation
#
# GRAMMAR:
# annotation :← '@' '描述' stringLit
#
# EXPECTED OUTPUT:
# No 入口 — declaration or test-runner surface only.
#
# BACKEND:
# declaration-only CLI metadata (whitelist: 描述/descriptio.fab).
#
@ 命令行 "descriptio-smoke"
@ description "Short CLI description"
main args args {
}