Xcode8에 문서 메모(함수 메모)를 추가하는 방법 정보

4749 단어 XcodeSwiftXcode8

입문


지금은 충분하게 느껴지지만 1부터 Xcode8 & Swift3를 배울 때 문서 평론의 작법은 이해하기 어려웠다. 고전했기 때문에 정보를 총결해야 한다
이번에 나는 이 함수에 자동으로 문서 평론을 입력하는 방법을 찾았다
func sampleMethod(value: String) -> String {
    return value;
}

시도한 문서 설명 쓰기


AndroidStudio에서 사용/** + EnterUnity에서 사용///입력해도 문서 주석의 데이텀이 자동으로 생성되지 않습니다.
단지 아래와 같다./** + Enter
/**

func sampleMethod(value: String) -> String {
    return value;
}
/** ... */에서 평론을 할 수 있지만 자동 보충*/도 없고 문서 평론을 자동으로 입력하는 모형도 없다///

///
func sampleMethod(value: String) -> String {
    return value;
}
이쪽도 마찬가지로 주석 출력으로 성립되었지만, 함수 주석의 모형은 자동으로 입력되지 않았다

외부 플러그인 사용


VVDocumenter-Xcode


http://dev.classmethod.jp/references/vvdocumenter-swift/
이 문제를 해결하기 위해 누군가가 외부 플러그인을 만들었기 때문에 바로 설치합니다
하지만 이쪽은 설치가 잘 안 돼요.
다음으로 Xcode 플러그인 설치는 일반적으로 Alcatraz라는 Xcode 플러그인의 패키지 관리자를 사용하지만, Alcatraz는 Xcode 8부터 지원하지 않습니다...
따라서 Xcode8부터 VVDocumenter-Xcode 등 외부 플러그인 가져오기가 어려워지는 것 같습니다.
(적어도 현재에서)

보충하여 기록하다


공식적인 대응과는 조금 다르지만
Xcode8에서 Alcatraz를 사용하는 방법이 있는 것 같아요.
https://github.com/alcatraz/Alcatraz/pull/488
따라서 "VVDocumenter-Xcode는 지금까지의 방법으로 가져올 수 없습니다."
오류 메시지 오류

사실 공식적으로 도입된 VVDocumenter-Xcode.


여기의 issue에 따르면 VVDocumenter-Xcode(또는 이를 바탕으로 개발된)는 XCode8에서 기본적으로 가져온 것 같다고 합니다.
그러면 이 글을 보면 다음과 같은 단축키로 문서 평론을 입력할 수 있다
Alt + Cmd + / 
바로 해보면...
/// <#Description#>
///
/// - Parameter value: <#value description#>
/// - Returns: <#return value description#>
func sampleMethod(value: String) -> String {
    return value;
}
완성!<##>의 외관이 좀 이상하다. 사실은 이런 느낌이다.

결론


Xcode8 이하:


VVDocumenter-Xcode 대응 가능

Xcode8 이상:


외부 플러그인을 가져올 필요가 없습니다.
입력Alt + Cmd + /을 통해 다음 문서 주석의 데이지 모양을 자동으로 입력합니다
/// <#Description#>
///
/// - Parameter value: <#value description#>
/// - Returns: <#return value description#>
func sampleMethod(value: String) -> String {
    return value;
}

좋은 웹페이지 즐겨찾기