如何显示带格式标记的源代码注释 Xcode中Option点击函数Quick Help无响应如何解决

问题原因 #

Xcode 针对 Swift 源码的文档注释解析不支持 Objective-C 风格的 @param、@return 标记，你当前使用的注释格式不符合 Swift 文档注释规范，因此无法生成可识别的 Quick Help 内容。

修复方案 #

将注释替换为 Swift 原生支持的 DocC 注释格式即可，如果需要保留英文注释仅调整标记格式即可，无需修改注释文本内容。修改后的中文注释代码示例如下：

/// 把图像缓冲区转换为 `UIImage` 实例
///
/// - Parameters:
///   - imageBuffer: 待转换的图像缓冲区
///   - orientation: 已经应用到图像的朝向参数
/// - Returns: 转换完成的新 `UIImage` 实例，转换失败则返回 nil
public static func createUIImage(
  from imageBuffer: CVImageBuffer,
  orientation: UIImage.Orientation
) -> UIImage? {
  let ciImage = CIImage(cvPixelBuffer: imageBuffer)
  let context = CIContext(options: nil)
  guard let cgImage = context.createCGImage(ciImage, from: ciImage.extent) else { return nil }
  return UIImage(cgImage: cgImage, scale: Constantss.originalScale, orientation: orientation)
}

验证操作 #

修改注释后执行以下操作确保缓存刷新：

• 按下 Command + Shift + K 清理普通构建缓存
• 按下 Option + Command + Shift + K 清理全部构建文件夹缓存
• 重启 Xcode 后按住 Option 点击函数名，即可在弹窗和右侧 Quick Help 面板看到对应的注释内容

内容的提问来源于stack exchange，提问作者Frederick C. Lee