Xcode 代码补全自定义说明

Posted 2023-02-24

【中文标题】Xcode 代码补全自定义说明

【英文标题】：Xcode code completion custom descriptions

【发布时间】：2017-06-28 11:01:01

【问题描述】：

对于某些方法，Xcode 的代码完成/建议/自动完成功能会显示描述：

当我创建类、函数、变量以及什么不提供描述时，描述不显示：

但是，在右侧的快速帮助菜单中，当单击alt+click 时，它会：

我试过this "solution"，但没用。我需要在描述中包含任何特殊字符吗？

注意

我目前使用的是 Xcode 9 beta 1，但我在 Xcode 8 中也遇到过这个问题。

更新

很高兴它现在可以在 Xcode 9 GM 中使用。

【参考方案1】：

我认为原因可能是 /// 后面没有空格。 正确的方法应该是

/// This is a description

事实上，如果您为屏幕截图中提到的函数添加文档，则会添加 cmets 本身，其中您可以看到 /// 之后的空格。添加 cmets/文档的正确方法是完整的。 一旦您选择单击函数调用，就会显示描述。 Apple 在自动完成中显示描述的方式是它自己做的事情。您可能想为此使用AppleDoc。

【讨论】：

呃，对我来说这似乎不起作用。我也打了shift+cmd+k清理，还是没有出现。

@LinusGeffarth ：编辑了我的答案。你能再检查一下吗？

您可能误解了我的问题：我不是在寻找单击选项时出现的描述 - 这已经有效。我希望在点击esc 以弹出代码建议时显示描述。 （并且无论何时出现建议。）

@LinusGeffarth：正确。这就是为什么我在回答中建议使用 AppleDoc :) 这应该可以解决您的问题。

哦，对了。如果可能的话，我不想使用第三方软件……不过谢谢！

【参考方案2】：

目标-C

1.只需在您的方法之前添加描述，就像示例一样。

@interface VVLabelBold : UILabel
-(void) setDefaultTextColor;

/**Disabled Label, This description will show in auto-complete*/
-(void) setDisabled;

@end

2 UILabel的调用方法

[lblSample setDisabled];