매개변수와 계약
매개변수와 계약의 작동 예제와 작성 인터페이스입니다.
식별자, 타입, 설명에 전체 읽기 너비가 필요한 API 입력에는 DocumentParameters를 사용하세요. 필수와 선택 상태는 텍스트로 표시하며 검증 컨트롤이 아닙니다. 중첩 경로는 전체 이름을 유지하고 부모가 제공된 경우의 필수 조건을 명시합니다.
- class
Name stringRequired 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과 검색에 유지하세요.