对于某些方法,Xcode 的代码完成/建议/自动完成功能会显示说明:

ios - Xcode 代码补全自定义描述-LMLPHP

当我创建类、函数、变量和什么不提供描述时,描述不显示:

ios - Xcode 代码补全自定义描述-LMLPHP

但是,在右侧的快速帮助菜单中,单击 alt+click 时,它​​会:

ios - Xcode 代码补全自定义描述-LMLPHP

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

笔记

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

更新

很高兴地说它现在在 Xcode 9 GM 中对我有用。

最佳答案

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

/// This is a description

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

ios - Xcode 代码补全自定义描述-LMLPHP

关于ios - Xcode 代码补全自定义描述,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/44800620/

10-13 08:18