빠른 문서 주석

2892 단어 XcodeSwift
추기: Xcode8의 말주석을 간단하게 삽입할 수 있는 데이지
Swift의 문서 메모 작성 방법은 Xcode7부터(Swift2부터?)변한 것 같아서 메모를 해요.

Xcode7의 쓰기

  • Markdown 형식
  • 매개 변수는- parameter <パラメーター名>: <説明>
  • 반환값은 입니다- returns: <説明>
  • 예제
    /// なんか **うまいこと** やるよ。
    /// - parameter foo: 1つ目の引数。
    /// - parameter bar: 2つ目の引数。
    /// - returns: うまいことやったらtrueを返すよ。
    func doSomething(foo: String, bar:Int) -> Bool {
        // do nothing :P
        return false
    }
    
    메소드 이름에서 Option - 확인 을 클릭합니다.

    참고물
  • http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/
  • Xcode6의 쓰기

  • reStructuredText 형식입니다
  • 매개 변수는:param: <パラメーター名> <説明>
  • 반환값은 입니다:returns: <説明>
  • 예제
    /// なんか **うまいこと** やるよ。
    ///
    /// :param: foo 1つ目の引数。
    /// :param: bar 2つ目の引数。
    /// :returns: うまいことやったらtrueを返すよ。
    func doSomething(foo: String, bar:Int) -> Bool {
        // do nothing :P
        return false
    }
    
    메소드 이름에서 Option - 확인 을 클릭합니다.

    참고물
  • http://nshipster.com/swift-documentation/
  • 좋은 웹페이지 즐겨찾기