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     */


MFR_symbol_field_Postcondition_2x



前:Parameters (パラメータ) 次:Precondition (前提条件)
















トップへ












トップへ












トップへ












トップへ












トップへ
目次
Xcode の新機能

マークアップの本質


マークアップの使用


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


一行のテキストの構成


複数行のテキストの構成


文字のスパンの構文


リンクの挿入


アセットの挿入


コールアウトの挿入

  • Attention(注意)
  • Author(著者)
  • Authors(著者)
  • Bug(バグ)
  • Complexity(複雑さ)
  • Copyright(著作権)
  • Custom Callout(カスタムのコールアウト)
  • Date(日付)
  • Exsample(例)
  • Experiment(実験)
  • Important(重要な)
  • Invariant(不変な)
  • Localization Key(ローカル化キー)
  • Note(注意)
  • Parameter(パラメータ)
  • Parameters(パラメータ)
  • Postcondition(事後条件)
  • Precondition(前提条件)
  • Remark(注目)
  • Returns(応答)
  • Requires(要件)
  • See Also(以下も見よ)
  • Since(以来)
  • Throws(スロー)
  • To Do(すべき)
  • Version(バージョン)
  • Warning(警告)

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


    改訂履歴














    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ