Xcode 8 how to show description of function while

Question

How can I show a brief description of a function while typing like the image show below? I've tried many different options all have failed.

Option + click works but that's not what I'm looking for.

Option 1

 /// Testing...
  /// - returns: false
  func testing()->Bool{
    return false
  }

Option 2

/**
Testing option two
*/
func testing()->Bool{
        return false
}

This issue has been fixed in Xcode 9

Answer 1

I am using Xcode 9.4.1 and I found this...

Parameters picked from function automatically. Place your cursor on the line above the function.

/// <#Description#>
///
/// - Parameters:
///   - param1: <#param1 description#>
///   - param2: <#param2 description#>

Answer 2

Have you set:

Preferences -> Text Editing -> Suggest completions while typing

It might also help to install the guides and sample code at:

Preferences -> Components -> Documentation Tab -> "Check and Install Now" or the arrow next to guides and sample code to just download it once

Answer 3

If you are looking for the way to document self-created method in swift then this might give you a way out.

import Foundation
///                                                                     

                                                        
            

查看更多

0人赞 添加讨论(0) 举报

Answer 4

Select your function or place the cursor before your function, then click

Xcode - Editor - Structure -> Add Documentation.

/**
 <#Description#>
 */

Save the file, or simply restart the Xcode. Then check the suggestion while calling the respective function. I hope this might help.