[解決済み] Xcode 8 の自動生成クイックヘルプ・ドキュメント

質問

で発表された新機能のうち Xcode 8 を見ることができます。

クイックヘルプのドキュメントを自動生成する" :

これは、私たちのような手動コードドキュメントの終わりなのでしょうか？ NSHipsterのこの記事で学ぶことができます。 ?

この新機能の長所と短所を概説できますか？ Jazzy のようなツールに取って代わるものでしょうか？ ?

新しい機能についての詳しい情報は見つかりませんでした。

どのように解決するのですか？

これは、Xcode 8（以降）の機能で、このようにメソッドを選択できることを指しています。

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

... そして ⌘ + オプション + / (または、Xcodeの「Editor」メニューから「Structure」 " 「Add documentation」を選択)すると、次のようなコメントテンプレートが生成されます。

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

クイックヘルプのためのドキュメントを書きやすくするだけです。

この動作は時間とともに少し変わりましたが、Xcode は、これを実行しようとするときにカーソルがどこになければならないかについて、特別な場合があることに注意してください。たとえば、カーソルは関数名のどこかでなければなりません。 foo のように、関数名のどこかにカーソルがなければなりません。あるいは、関数名をダブルクリックしてから ⌘ + オプション + /

この機能は Jazzy のようなツールに取って代わるものなのか、というご質問ですね。

いいえ、Jazzy や同様のツールを置き換えるものではありません。とりわけ、Jazzy はこのインライン ドキュメントからスタンドアロンの HTML ドキュメントを作成します。つまり、何らかの理由で Jazzy からのこれらのスタンドアロン出力が必要かどうかが問題なのです。もし必要なら、Jazzy (または同様のツール) をこの統合されたドキュメントと一緒に使ってください。そうでない場合 (つまり、Xcode IDE 内からのドキュメントのみを探している場合)、Jazzy は必要ありません。