ios - Xcode 代码完成自定义描述

Question

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

当我创建类、函数、变量等不提供描述时，描述没有显示:

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

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

注意事项

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

更新

很高兴地说它现在适用于 Xcode 9 GM。

Answer 1

我觉得可能是///后面没有空格。
正确的做法应该是

/// This is a description

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