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, вкладка Места

и нажмите на маленькую стрелку, чтобы открыть видоискатель, и вручную удалить папку.

Restart 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 не анализирует их из своих классов, а скорее из отдельного набора документации (который вы можете найти на вкладке Help/Documentation and API reference Xcode).

Так что, если Apple не решит изменить это, я боюсь, что в popover вы не сможете увидеть свою собственную.

Вы можете следить за существующими генераторами набора док-станции (AppleDoc, Jazzy), возможно, они предложит способ связать свою документацию с пополнением Xcode.

Имейте в виду, что вы видите свои комментарии при открытии быстрой помощи поповер с альт + клик по методу или свойству.