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


85

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

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

ここに画像の説明を入力してください

これは、NSHipsterからこの記事で学ぶことができるような手動コードドキュメントの終わりですか?

誰かがこの新機能の長所と短所を概説できますか?Jazzyのようなツールに取って代わりますか?

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


@Rob:Xcode8bêtaをインストールしてすぐにアンインストールする手間をかけずに、どのように見えるかを確認する方法はありますか(私の仕事のMacにインストールすることは許可されていません)
H4Hugo 2016年

これは、いくつかのWWDC2016ビデオで示されています。
ロブ


2
37:00にビデオでデモを見ることができますが、実際に動作させることはできません。私はswiftとobj-cを使って、関数のさまざまな部分を選択してみました。
混乱したVorlon 2016年

回答:


203

これは、Xcode 8(およびそれ以降)の機能を指し、次のような方法を選択できます。

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

...そして押し+ option+ /(または「構造」»Xcodeのの『編集』メニューから『ドキュメントの追加』を選択してください)、それはあなたのために以下のコメントテンプレートを生成します。

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

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


この動作は時間の経過とともに少し変化しますが、Xcodeは、これを実行しようとするときにカーソルがどこにある必要があるかに注意を払うことができることに注意してください。たとえば、これが機能するにfooは、上記の例では、カーソルが関数名のどこかにある必要があります。それとも、二重の関数名をクリックし、キーを押し+ option+/


1
あなたはそれを機能させることができますか?できません。できれば; コマンドを使用するときに何を選択しますか?私は...ただ、すべてのオプションについて試してみました
Vorlon混乱

2
メソッド名のどこかにカーソルを置き、Xcode 8でcommand + option + "/"を押します(また、 "Editor"-"Structure"-"Adddocumentation"を選択しました)。正常に動作します。私がこれまでに遭遇した唯一の問題は、@IBActionメソッドと混同されているように見えることです。ただし、Objective-CとSwiftの両方で問題なく動作します。それでも問題が解決せず、Xcodeを再起動したり、マシンを再起動したりするという通常の不完全な手順を試した場合は、このベータ版ソフトウェアに関するバグレポートを投稿することをお勧めします。
ロブ

2
再起動を試みましたが、それでも喜びはありません。バグレポートを提出しました。
混乱したVorlon 2016年

5
実際にはXcode8ベータ1の時点で機能していますが、El Capitanを使用している場合は、Xcodesudo /usr/libexec/xpccachectlを起動し、必要なシステムコンポーネントをインストールしてから、ターミナルで実行し、Macまたは他のXcode拡張機能が起動する前に再起動する必要があります。作業。Xcode8リリースノートを参照してください。
クリス・

1
私はそれが散発的に機能することを発見しました。うまくいくこともあれば、まったくうまくいかないこともあります。理由もわかりません。率直に言って、それが機能するとき、私はそれが自動生成するものがかなりまばらであることに気づきます(説明のメソッド名?)。それが問題なく動作することをあなたのそれらのために、素晴らしい。私たちの中には、散発的であるか、単に機能しない人もいます。
ロイドサージェント

7

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

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

残念ながら現在も機能しないショートカット「///」は、おそらくこのショートカットを正確に使用していた古いXCodeプラグインVVDocumenterが原因です。

素晴らしい機能、Apple側のひどいQA。


このバグはXcode8ベータ版にありましたが、リリースされたバージョンで修正されています。
Eric Aya

8A218aはリリースされたバージョンであり、コメントショートカットは私にとって再び機能します(ベータ版ではありませんでした)。
Eric Aya

Shiftキーを使用せずに「/」を取得するキーボードレイアウトを使用していますか?
クラウスブッセ2016

はい、私は2つのキーボードを持っています。「:」の上に「/」が付いたフランスのAzerty配列と、アメリカのQwerty配列です。コメントショートカットはどちらも問題なく機能します。
Eric Aya

まあ、それは私(アメリカンキーボード)にとって断続的です。
ロイドサージェント
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.