web-dev-qa-db-ja.com

Xcode 8自動生成クイックヘルプドキュメント

Xcode 8 で発表された新機能の中には、

「クイックヘルプドキュメントの自動生成」：

enter image description here

これは私たちのような手動のコード文書の終わりですか？ NSHipsterからこの記事で学ぶことができます ？

誰かがこの新機能の長所と短所の概要を説明できますか？ Jazzyなどのツールに置き換わります ？

新機能に関する詳細情報が見つかりませんでした。

xcodeswiftxcode8
77
H4Hugo

これはXcode 8（以降）の機能を指し、次のような方法を選択できます。

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

...を押します ⌘+option+/ （またはXcodeの[エディター]メニューから[構造]"[ドキュメントの追加]を選択すると、次のコメントテンプレートが生成されます。

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

クイックヘルプのドキュメントの作成を容易にするだけです。

この振る舞いは時間の経過とともに少し変化しますが、Xcodeは、これを行おうとしたときにカーソルがどこにある必要があるかを特定できることに注意してください。たとえば、これが機能するためには、カーソルは関数名のどこかにある必要があります。上の例ではfooです。または、関数名をダブルクリックしてから ⌘+option+/

184
Rob

これは、キーボードでShiftキーを押して取得する必要がある場合、「/」の付いたすべてのホットキーが現在のXCode 8ビルドで機能しないという事実に関連している可能性があります。

つまりドイツ語のキーボードでは、「/」はshift + 7であり、alt + cmd + shift-7を押しても何も起こりません。つまり、cmd + shift + opt + dを割り当てると、うまく機能します。

残念ながら今のところ機能しないショートカット '///'は、おそらくこのショートカットを使用した古いXCodeプラグインVVDocumenterによるものです。

すばらしい機能、Apple側の粗末なQA。

6
Klaus Busse