Xcode 8如何在打字时显示功能描述

Question

如何在键入时显示功能的简要说明,如下图所示？我尝试过很多不同的选择都失败了.

选项+点击有效,但这不是我想要的.

选项1

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

选项2

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

此问题已在Xcode 9中修复

Answer 1

如果您正在寻找在swift中记录自创方法的方法,那么这可能会给您一个出路.

import Foundation
///  A two-wheeled, human-powered mode of transportation.
class Bicycle {
/**
    Frame and construction style.

    - Road: For streets or trails.
    - Touring: For long journeys.
    - Cruiser: For casual trips around town.
    - Hybrid: For general-purpose transportation.
*/
enum Style {
    case Road, Touring, Cruiser, Hybrid
}

/**
    Mechanism for converting pedal power into motion.

    - Fixed: A single, fixed gear.
    - Freewheel: A variable-speed, disengageable gear.
*/
enum Gearing {
    case Fixed
    case Freewheel(speeds: Int)
}

/**
    Hardware used for steering.

    - Riser: A casual handlebar.
    - Café: An upright handlebar.
    - Drop: A classic handlebar.
    - Bullhorn: A powerful handlebar.
*/
enum Handlebar {
    case Riser, Café, Drop, Bullhorn
}

/// The style of the bicycle.
let style: Style

/// The gearing of the bicycle.
let gearing: Gearing

/// The handlebar of the bicycle.
let handlebar: Handlebar

/// The size of the frame, in centimeters.
let frameSize: Int

/// The number of trips travelled by the bicycle.
private(set) var numberOfTrips: Int

/// The total distance travelled by the bicycle, in meters.
private(set) var distanceTravelled: Double

/**
    Initializes a new bicycle with the provided parts and specifications.

    - Parameters:
        - style: The style of the bicycle
        - gearing: The gearing of the bicycle
        - handlebar: The handlebar of the bicycle
        - frameSize: The frame size of the bicycle, in centimeters

    - Returns: A beautiful, brand-new bicycle, custom built
      just for you.
*/
init(style: Style, gearing: Gearing, handlebar: Handlebar, frameSize centimeters: Int) {
    self.style = style
    self.gearing = gearing
    self.handlebar = handlebar
    self.frameSize = centimeters

    self.numberOfTrips = 0
    self.distanceTravelled = 0
}

/**
    Take a bike out for a spin.

    - Parameter meters: The distance to travel in meters.
*/
func travel(distance meters: Double) {
    if meters > 0 {
        distanceTravelled += meters
        ++numberOfTrips
    }
}
}

关于NSHipster的Swift文档

Answer 2

选择功能或将光标放在功能之前,然后单击

Xcode - Editor - Structure -> Add Documentation.

/**
 <#Description#>
 */

保存文件,或只是重新启动Xcode.然后在调用相应功能时检查建议.我希望这可能有所帮助.

Answer 3

我正在使用Xcode 9.4.1，我发现了这个...

从功能中自动选择参数。将光标放在函数上方的行上。

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

Answer 4

您是否设置：

首选项 -> 文本编辑 -> 输入时建议完成

在以下位置安装指南和示例代码也可能有所帮助：

首选项 -> 组件 -> 文档选项卡 -> “立即检查并安装”或指南和示例代码旁边的箭头只需下载一次