Postcondition(事後条件)

Postcondition (事後条件) 区切り文字を使用して、シンボルのクイックヘルプに Postcondition (事後条件) コールアウトを追加します。説明セクションには、マークアップの場合と同じ順序で複数のPostcondition (事後条件) コールアウトが表示されます。

コールアウトを使用して、シンボルの実行完了時に値が保証されている条件を文書化します。

以下の物で動作します

プレイグラウンド

✓ シンボルの文書

文法

* | + | - Postcondition:

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

例

 1    /**
 2      An example of using the Postcondition field
 3
 4      - Postcondition:
 5      After completing this method the billing address for
 6      the person will be set to `updatedAddress` if it is valid.
 7      Otherwise the billing address will not be changed.
 8     */