Xcode 8 자동 생성 빠른 도움말 문서

Xcode 8 자동 생성 빠른 도움말 문서

Xcode 8에서 발표된 새로운 기능 중에서, 우리는 볼 수 있습니다.

"빠른 도움말 문서 자동 생성":

NSHipster에서 이 기사에서 배울 수 있는 것과 같은 수동 코드 문서화는 이것으로 끝입니까?

누가 이 새로운 기능의 장단점을 개략적으로 설명할 수 있습니까?Jazzy와 같은 도구를 대체합니까?

새 기능에 대한 자세한 정보를 찾을 수 없었습니다.

이는 다음과 같은 방법을 선택할 수 있는 Xcode 8 이상의 기능을 말합니다.

func foo(bar: Int) -> String { ... }

그런 다음 ++option/를 누릅니다(또는 Xcode의 "Editor" 메뉴에서 "Structure" » "Add documentation"을 선택합니다). 그러면 다음 주석 템플릿이 생성됩니다.

/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>

빠른 도움말을 위한 설명서를 쉽게 작성할 수 있습니다.

---

이 동작은 시간이 지남에 따라 약간 변경되었지만 Xcode는 이 동작을 시도할 때 커서가 어디에 있어야 하는지에 대해 신중할 수 있습니다.예를 들어 커서는 함수 이름의 어딘가에 있어야 합니다.foo위의 예에서, 이것이 작동하기 위해.또는 기능 이름을 두 번 클릭한 다음 ++option/를 누릅니다.

---

당신은 이 기능이 Jazzy와 같은 도구를 대체하는지 물었습니다.

아니요, Jazzy나 비슷한 도구를 대체하지 않습니다.무엇보다도 Jazzy는 이 인라인 문서에서 독립 실행형 HTML 문서를 만듭니다.즉, 이것은 단순히 여러분이 어떤 이유로든 Jazzy의 이러한 독립적인 결과물이 필요한지에 대한 질문입니다.그렇다면 이 통합 설명서와 함께 Jazzy(또는 유사한 도구)를 사용하십시오.그렇지 않은 경우(즉, Xcode IDE 내에서 문서만 찾고 있는 경우), Jazzy는 필요하지 않습니다.

이는 키보드를 가져오려면 Shift 키를 눌러야 하는 경우 현재 XCode 8 빌드에서 '/'가 있는 모든 단축키가 작동하지 않는다는 사실과 관련이 있을 수 있습니다.

즉, 독일어 키보드에서 '/'는 shift+7이지만 alt+cmd+shift-7을 눌러도 아무 일도 일어나지 않습니다.cmd+shift+opt+d와 같이 할당하면 정상적으로 작동합니다.

안타깝게도 바로 가기 '//'도 지금은 작동하지 않습니다. 아마도 이 바로 가기를 사용했던 이전 XCode 플러그인 VDocumenter 때문일 것입니다.

훌륭한 기능, 애플 쪽의 형편없는 QA.

언급URL : https://stackoverflow.com/questions/38071289/xcode-8-auto-generated-quick-help-documentation