2016-06-28 86 views
45

其中在Xcode 8宣佈的新功能,我們可以看到Xcode中8自動生成的快捷幫助文檔

「自動生成快速幫助文檔」:

enter image description here

是手動本月底代碼文檔像我們can learn on this article from NSHipster

有人可以概述這個新功能的利弊嗎? Does it replace tools like Jazzy

我找不到關於新功能的更多信息。

+0

@Rob:任何想法如何我可以海如何看起來像沒有安裝Xcode 8bêta的痛苦並卸載它之後(未授權將它安裝在我的作業的mac) – H4Hugo

+0

它在一些WWDC 2016視頻中已被證明。 – Rob

+1

https://developer.apple.com/videos/play/wwdc2016/102/ – Rob

回答

110

他們只是說,在Xcode 8,你可以選擇這樣的方法:

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

然後按命令 + 選項 + /或選擇 「結構」 - 「添加文件「從Xcode的」編輯器「菜單中,它會爲您生成以下注釋模板:

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

它只是簡化了d用於快速幫助。


注意,雖然這種行爲已經改變了一點隨着時間的推移,Xcode中可以特別在哪裏,當你試圖做到這一點,光標必須。例如,遊標必須位於函數名稱foo中的某個位置,這樣才能工作。或函數的名稱只要雙擊,然後按命令 + 選項 + /

+1

你可以得到它的工作?我不能。如果你可以的話;當你使用命令時你選擇了什麼?我試過幾乎每一個選項... –

+2

我只是把我的光標放在方法名稱的某處,然後按下命令+選項+「/」(以及選擇了「編輯器」 - 「結構」 - 「添加文檔」) Xcode 8和它工作正常。我迄今遇到的唯一問題是它似乎與'@ IBAction'方法混淆。但它適用於Objective-C和Swift。如果您仍然遇到問題,並嘗試了重新啓動Xcode和/或重新啓動計算機的常見步驟,那麼您可能只想發佈有關此測試版軟件的錯誤報告。 – Rob

+2

我只是嘗試重新啓動,但仍然沒有快樂。我提交了一個錯誤報告。 –

2

這很可能是相關的事實與所有熱鍵一個「/」不要在當前工作的XCode 8版本,如果你的鍵盤需要按shift來獲取它。

I.e.在德國鍵盤上'/'是shift + 7,按alt + cmd + shift-7不會做任何事情。如果你指定即cmd + shift + opt + d,它工作得很好。

快捷方式'///',不幸的是現在不能正常工作,可能是由於舊的XCode插件VVDocumenter,它正好使用了這個快捷方式。

偉大的功能,蘋果方糟糕的QA。

+0

Xcode 8 beta中存在這個錯誤,但它已在發佈的版本中修復。 – Moritz

+0

我是@版本8.0(8A218a),有沒有更新的? –

+0

8A218a是發佈的版本 - 並且評論快捷方式再次爲我工作(沒有在beta版中)。 – Moritz