Xcode代码补全自定义描述

Question

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

当我创建类、函数、变量等并提供描述时，描述不会显示出来。

然而，在右侧的快速帮助菜单中，以及点击alt+click时，它会执行：

我尝试了this "solution"，但它没有起作用。在描述中是否需要包含任何特殊字符？

注：

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

更新：

很高兴地说，现在在Xcode 9 GM中已经可以工作了。

- LinusGeffarth

Answer 1

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

/// This is a description

事实上，如果你像截图中提到的那样为函数添加文档，注释本身就已经被添加了，在///之后可以看到有空格。这是添加注释/文档的正确方式。
一旦你选中函数调用，描述就会显示出来。
苹果在自动完成中显示描述的方式是它自己完成的。你可能想使用AppleDoc来完成这个功能。

- Nitish

---

对我来说，似乎不起作用。我还按下 shift+cmd+k 进行清理，但它仍然没有出现。 - LinusGeffarth

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

你可能误解了我的问题：我不是要在选项点击时显示描述 - 这已经可以了。我希望在按下 esc 以弹出代码建议时，描述也会显示出来。（以及每当建议出现时。） - LinusGeffarth

@LinusGeffarth ：没错。这就是为什么我在我的回答中建议使用AppleDoc :) 这应该能解决你的问题。 - Nitish

好的。如果可能的话，我不想使用第三方软件...谢谢! - LinusGeffarth

Answer 2

Objective-C

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

@interface VVLabelBold : UILabel
-(void) setDefaultTextColor;

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

@end

UILabel 的 2 种调用方法

[lblSample setDisabled];

- Vivek