Parameters(パラメータ)

シンボルのクイックヘルプの Parameters (パラメータ) セクションにパラメータ名と説明のリストを追加します。クイックヘルプの Parameter (パラメータ) の順序は、区切り文字に表示される順序と同じです。複数の Parameters (パラメータ) 区切り文字は、マークアップに表示される順序でクイックヘルプに追加されます。

Parameters (パラメータ) セクションは、シンボルのマークアップに少なくとも 1 つの Parameters (パラメータ) またはParameter (パラメータ) 区切り文字がある場合にのみ、クイックヘルプに追加されます。このセクションには、すべての Parameters (パラメータ) 区切り文字のエントリと、それに続くすべての Parameter (パラメータ) 区切り文字のエントリが含まれています。

以下の物で動作します

プレイグラウンド

✓ シンボルの文書

文法

* | + | - Parameters:

* | + | - :

…

各 Parameter (パラメータ) 名のアスタリスク (*)、プラス記号 (+)、またはハイフン (-) は、Parameters (パラメータ) 区切り文字の最初の文字から 3〜6 空白分インデントされます。すべての Parameter (パラメータ) 名は同じレベルにインデントされます。

<parameter name> は、クイックヘルプの Parameter (パラメータ) 名に使用されます。Parameter (パラメータ) の説明は、クイックヘルプの構文のパラメータのセクションで説明されているように作成されます。

例

 1    /**
 2      - Parameters:
 3        - cubes: The cubes available for allocation
 4        - people: The people that require cubes
 5     */

代替案

Parameter (パラメータ) 区切り文字を使用して、単一のパラメーターを追加します。

前：Parameter (パラメータ) 次：Postcondition(事後条件)

トップへ

トップへ

トップへ

トップへ

トップへ

Custom Callout(カスタムのコールアウト)

Localization Key(ローカル化キー)

Note(注意)

Parameter(パラメータ)

Parameters(パラメータ)

XCode 11.1 日本語化計画：Markup Formatting Reference

Parameters(パラメータ)

文法

例

代替案