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

Precondition(前提条件)

シンボルのクイックヘルプに Precondition (前提条件) コールアウトを追加します。説明セクションには、マークアップの場合と同じ順序で複数の Precondition (前提条件) コールアウトが表示されます。

コールアウトを使用して、文書化されたシンボルが機能するために保持されている全ての条件を文書化します。

以下の物で動作します

    プレイグラウンド




✓ シンボルの文書

文法

* | + | - Precondition: description




optional continuation of description

Precondition (前提条件) コールアウトのクイックヘルプに表示される説明は、パラメータのセクション の説明に従って作成されます。

例

 1    /**
 2      An example of using the precondition field
 3
 4      - Precondition: The `person` property must be non-nil.
 5      - Precondition: `updatedAddress` must be a valid address.
 6     */

前：Postcondition (事後条件) 次：Remark (注目)

マークアップの本質

マークアップの使用

マークアップ用のコメントマーカー

一行のテキストの構成

複数行のテキストの構成

文字のスパンの構文

リンクの挿入

アセットの挿入

コールアウトの挿入

Escaping Special Characters (特別な文字のエスケープ)

改訂履歴