XCode 8.2.1未顯示有關自動完成的文檔說明

Question

我在向XCode 8.2.1的代碼中添加文檔時遇到問題。

這裏是我的代碼：

/// Test documentation method 
/// 
/// - Parameter string: The input string 
/// - Returns: The output bool 
func testMethod(string:String) -> Bool { 

    if string == "YES" { 
     return true 
    } 

    return false 
} 

文檔顯示爲預計在快速幫助窗口，但該說明並不在代碼自動完成的窗口顯示。

有沒有辦法讓自動完成框中顯示的說明，如下圖所示：

謝謝。

Answer 1

對我來說，解決這個問題的最好方法是清理項目Shift + Command + K，如果這不起作用，刪除Derived Data文件夾是個上帝的主意。

要刪除這個文件夾去Xcode的喜好，位置標籤

，並點擊小箭頭打開取景器，並手動刪除該文件夾。

重新啓動的Xcode，並檢查是否是現在工作

Answer 2

https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/MarkupFunctionality.html#//apple_ref/doc/uid/TP40016497-CH54-SW1

請參考官方文檔

Answer 3

你是對的，你添加到你的方法和屬性上的說明不再出現在popover中。

如上所述，您只能看到Apple自己的方法和屬性的描述。
原因是Xcode並沒有從它們的類中解析這些文件，而是從一個單獨的文檔集（你可以在Xcode的Help/Documentation and API reference標籤中找到）中解析它們。因此，除非蘋果決定改變這種情況，否則恐怕在彈出窗口中看不到你自己的東西。

您可以留意現有的文檔集生成器（AppleDoc,Jazzy），也許他們會提供一種將文檔鏈接到Xcode popover的方法。

記住與ALT +點擊上方法或屬性打開快速幫助酥料餅的時候，你看到自己的意見。