2016-07-20 3 views
1

Xcode 8에는 자동 설명이 포함되어 있습니다. 자체 문서를 만들었으므로 설명/데이터/응답/오류 섹션을 작성하고 싶습니다. 여기 스크린 샷이 있는데 내 질문은 애플이 어떻게 정보를 상자에 넣을 것인가? 나는 이것에 대한 문서를 전혀 찾을 수 없다. 발췌 여기Xcode Swift 빠른 도움말 닫기

http://nshipster.com/swift-documentation/

됩니다 :

/// The total distance travelled by the bicycle, in meters. 
private(set) var distanceTravelled: Double 

/** 
    Initializes a new bicycle with the provided parts and specifications. 

    - Parameters: 
     - style: The style of the bicycle 
     - gearing: The gearing of the bicycle 
     - handlebar: The handlebar of the bicycle 
     - frameSize: The frame size of the bicycle, in centimeters 

    - Returns: A beautiful, brand-new bicycle, custom built 
     just for you. 
*/ 
init(style: Style, gearing: Gearing, handlebar: Handlebar, frameSize centimeters: Int) { 
    self.style = style 
    self.gearing = gearing 
    self.handlebar = handlebar 
    self.frameSize = centimeters 

    self.numberOfTrips = 0 
    self.distanceTravelled = 0 
} 

다른 예 및 옵션의 호스트가 있습니다를 Screen shot of quick help

+0

무슨 "상자"에 대해 이야기하고 있습니까? – matt

+0

나는 그가 스크린 샷 하단의 테이블을 의미한다고 생각한다 – Feldur

+0

가능한 복제본은 http://stackoverflow.com/q/38669725/1271826이다. (물론, 그 대답은 완전히 만족스럽지 않다). – Rob

답변

-1

NSHipster는 스위프트 코드 인라인 문서를 작성하는 방법에 좋은 작성자가 있습니다 그 게시물에 상세히. 이 같은

댓글 포맷터는 속성, 클래스, 기능 등

희망이 도움에 옵션을 클릭 할 때 표시되는 문서 팝 오버를 채 웁니다.

+0

감사합니다. NSHipster를 사용해 보았습니다 만, 이것은 내가 찾고있는 것이 아닙니다. 언젠가 내가 애플을 제외하고하지 않았을 때 마침내 그것을 알아 냈습니다. 완성 블록에 이름을 부여해야했지만, 결과가 이름이 마지막으로 사용 된 이름과 다른 이름 인 경우 이름을 사용하면됩니다. –

+0

당신의 질문은 인라인 문서를 작성하는 방법을 알고 싶어합니다. 실제로 클로저와 명명 된 인수와 관련이 있음을 나타내려면 수정해야합니다. –

+0

실제로 그의 질문은 그가 클로저 매개 변수에 대한 문서를 찾고 있다는 것을 분명하게 생각한다고 생각합니다. (즉, "설명/데이터/응답/오류 섹션"에 대한 참조와 제목의 "클로저"에 대한 명시적인 참조 이 질문). 이 대답은 좋지만 클로저 매개 변수의 매개 변수를 문서화하는 방법에 대한 질문에 대해서는 대답하지 않습니다. – Rob