재정의된 메서드에 대한 신속한 문서 주석? (Swift documentation comments for overriden methods?)


문제 설명

재정의된 메서드에 대한 신속한 문서 주석? (Swift documentation comments for overriden methods?)

클래스가 UICollectionViewDataSource를 준수한다는 사실 때문에 구현된 Swift 함수에 마크업 문서를 추가하고 싶습니다. 예:

///
/// ‑ returns: Why is this documentation ignored?
///
override func collectionView(collectionView: UICollectionView, numberOfItemsInSection section: Int) ‑> Int {
    return 2
}

분명히 내 의견은 무시되고 생성된 문서는 계약 정의(또는 다른 기본 위치)에서 상속된 문서로 남아 있습니다. 빠른 도움말(Xcode 7.1.1)에는 다음 텍스트가 포함되어 있습니다.

Returns 섹션의 행 수입니다.

내 구현에서 변경 사항을 호출하기 위해 이러한 기본 문서를 "재정의"하려면 어떻게 해야 합니까?


참조 솔루션

방법 1:

Seems like in overridden functions you need to give the multi‑line comment (seems like /* */ doesn't work, you need /** */) instead of multi single‑lines. What is interesting, multi single‑line comments work fine for not overridden functions. What is even more interesting, as you are typing the method you get the correct, overridden comment, but Quick Help just ignores it once you type it off and click alt.

Example:

/**
    Works fine as you are typing.
*/
override func viewDidAppear() {
    print("test")
}

(by Druxsunshinejr)

참조 문서

  1. Swift documentation comments for overriden methods? (CC BY‑SA 2.5/3.0/4.0)

#swift2 #Documentation #swift #iOS #ios9






관련 질문

재정의된 메서드에 대한 신속한 문서 주석? (Swift documentation comments for overriden methods?)

Swift 2 "Type 'NSCalendarUint'에 'YearCalendarUnit' 멤버가 없습니다" 오류가 발생했습니까? (I got error with in Swift 2 "Type 'NSCalendarUint' has no member 'YearCalendarUnit' "?)

Xcode 7: 사용자 정의 키보드가 시뮬레이터에 표시되지 않음 (Xcode 7: Custom keyboard is not showing in simulator)

게임 데이터를 저장하려고 할 때 오류가 발생했습니다. (Error when trying to save gamedata)

Alamofire에서 캐시된 응답 감지 (Detect cached response in Alamofire)

언래핑 라인을 잡고 잡으시겠습니까? 스위프트 2.0, XCode 7 (Try and catch around unwrapping line? Swift 2.0, XCode 7)

ios swift tableview 셀 사이의 공간을 어떻게 변경할 수 있습니까? (How can I change the space between tableview cells ios swift)

.removeFromParent()가 작동하지 않음 (.removeFromParent() not working)

Swift2 UI 테스트 - 요소가 나타날 때까지 대기 (Swift2 UI Test - Wait for Element to Appear)

Swift의 View에 추가한 후 UIBezierPath의 색상을 변경하는 방법은 무엇입니까? (How to change the color of a UIBezierPath after added on View in Swift?)

swift에서 nil 객체와 문자열 연결 (string concatenate with nil object in swift)

포드 파일 없이 MWPhotoBrowser 사용 (Use MWPhotoBrowser without pod file)







코멘트