Xcode 代码完成自定义描述

Question

对于某些方法，Xcode 的代码完成/建议/auto-complete 功能显示说明：

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

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

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

备注

我目前使用的是 Xcode 9 beta 1，但我在 Xcode 8.

中也遇到过这个问题

更新

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

Answer 1

我觉得原因可能是///.
后面没有space 正确的方法应该是

/// This is a description

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

Answer 2

Objective-C

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

@interface VVLabelBold : UILabel
-(void) setDefaultTextColor;

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

@end

2 UILabel 的调用方法

[lblSample setDisabled];