对于某些方法,Xcode 的代码完成/建议/自动完成功能会显示描述:
当我创建类、函数、变量以及不提供描述的内容时,描述不会显示:
但是,在右侧的快速帮助菜单中,单击 时alt+click
,它会:
我尝试了这个“解决方案”,但没有奏效。我需要在描述中包含任何特殊字符吗?
笔记
我目前使用的是 Xcode 9 beta 1,但我在 Xcode 8 中也遇到了这个问题。
更新
很高兴地说它现在在 Xcode 9 GM 中对我有用。
我认为原因可能是///之后没有空格。
正确的方法应该是
/// This is a description
事实上,如果您为屏幕截图中提到的函数添加文档,则会添加注释本身,您可以在 /// 之后看到空格。这是添加评论/文档的正确方法。
一旦您选择单击函数调用,就会显示描述。
Apple 在自动完成中显示描述的方式是它自己做的事情。您可能希望为此使用AppleDoc。