2017-01-31 4 views
3

설명서의 마크 업을 추가했지만이 테이블을 채우는 방법을 알 수없는 경우 Swift의 블록 매개 변수가 블록 매개 변수 테이블과 함께 표시됩니다. 나는 그것을 Xcode markup reference formatting에서 찾았지만 그것에 관해 아무것도 찾을 수 없었다.Swift의 블록 매개 변수에 대한 문서화를위한 마크 업 형식은 무엇입니까?

예 :

Image of Xcode documentation view of a function

애플의 API를

가 완료 블록 매개 변수 테이블 작성을 보여

/** 
Foo 

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

이 내가 option + click 엑스 코드에서 함수에 위의 문서를 볼 경우에 표시되는 것입니다 . 이것은 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