ドキュメント

パラメーターと契約

パラメーターと契約の動作例と記述用インターフェース。

識別子、型、説明に本文幅全体が必要な API 入力には DocumentParameters を使います。必須・任意はテキストで示し、入力検証のコントロールとしては扱いません。ネストしたパスは完全な名前を保ち、親が指定されたときに必要になる条件も明記します。

classNamestringRequired: One complete class, including any selector or condition suffix.
modestringOptional: Use the active manifest’s default behavior when omitted.

range.start.characterintegerRequired when parent is provided: Zero-based UTF-16 code-unit offset. Keep the full path visible so readers can build the correct request object.

入力スキーマ全体

{  "type": "object",  "properties": { "className": { "type": "string", "minLength": 1 } },  "required": ["className"]}

展開した補足情報

ネイティブの折りたたみ要素は補足内容を文書内に保ち、キーボードで開閉できます。必須の手順は折りたたみ要素の外に置きます。

<DocumentParameters label="Parameters" parameters={[  { name: 'className', type: 'string', requirement: 'Required', description: 'One complete class.' }]} /><DocumentDisclosure title="Complete input schema">  <Code lang="json">{schema}</Code></DocumentDisclosure>

両方のコンポーネントは、示しているレイアウトの外側の文書フローに置きます。パラメーターがなければ普通の文で伝えます。長いコードは開閉領域内でスクロールし、パラメーターの説明は自然に折り返します。初期表示で閉じていても、完全な契約を可搬 Markdown と検索に残してください。

class の検査、ディレクティブの整形、CLI による生成で使われています。