Invariant(不変な)


Invariant (不変な) 区切り文字を使用して、シンボルの説明に Invariant (不変) のコールアウトを追加します。説明セクションには、マークアップと同じ順序で複数の Invariant (不変) のコールアウトが表示されます。


コールアウトを使用して、文書化されたシンボルの実行中に true になることが保証されている条件を表示します。


以下の物で動作します



文法


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




 1    /**
 2      An example of using the invariant field
 3
 4      - Invariant:
 5      The person reference will not change during the execution of this method
 6     */


MFR_symbol_field_invariant_2x



前:Important(重要な) 次:Localization Key(ローカル化キー)
















トップへ












トップへ












トップへ












トップへ












トップへ
目次
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 (特別な文字のエスケープ)


    改訂履歴














    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ












    トップへ