2017-01-31 10 views
3

マニュアル用のマークアップを追加すると、Swiftのブロックのパラメータがブロックのパラメータ用のテーブルに表示されますが、このテーブルの記入方法はわかりません。 Xcode markup reference formattingで検索しましたが、何も見つかりませんでした。Swiftのブロックのパラメータに関するドキュメントのマークアップ形式は何ですか?

例:

Image of Xcode documentation view of a function

AppleのAPIを

が完了ブロックパラメータテーブルが記入示しています

/** 
Foo 

- parameter completion: A block to execute 
*/ 
func foo(completion: (Bool) -> Void) { 
    // do something 
} 

これは私がoption + click Xcodeで機能に上記のドキュメントを表示する場合は、最大表示するものです。これはCloudKit APIドキュメントビューの例である:

Image of Xcode documentation view of a function

答えて

9

あなたは、パラメータに名前を与える必要がありますが、アンダースコアでそれに先立つ:

/** 
Foo 

- parameter completion: A block to execute 
- parameter aflag: Some Bool flag 
*/ 
func foo(completion: (_ aflag: Bool) -> Void) { 
    // do something 
} 

enter image description here

関連する問題