objective-c – 为Xcode 5的QuickH?elp创建一个枚举的文档字符串

发布时间：2020-12-14 17:22:55 所属栏目：百科来源：网络整理

导读：我想在 Xcode 5中记录一个枚举,以便我可以在自动完成弹出窗口中看到我的文档字符串作为快速帮助.例如,如果我这样做： //! Better than a normal int!typedef int superint; 然后我可以输入上级,弹出窗口显示superint,在弹出窗口的底部显示“比普通的int更好

我想在 Xcode 5中记录一个枚举,以便我可以在自动完成弹出窗口中看到我的文档字符串作为快速帮助.例如,如果我这样做：

//! Better than a normal int!
typedef int superint;

然后我可以输入上级,弹出窗口显示superint,在弹出窗口的底部显示“比普通的int更好！”.

不过,我似乎无法弄清楚是否有任何方法可以让它用于枚举.我的枚举看起来像这样：

typedef enum: unsigned int {
    a = 1,b = 2,c = 3,} abc_t;

预先添加//！ (或///或/ **)行在这种情况下不起作用.我输入“abc_”并在弹出窗口中显示完成,但底部没有docstring.

我有一个想法是Apple可能更好地支持使用他们的NS_ENUM()宏,但是//！在typedef之前的行上,NS_ENUM(…){…}也不起作用.

我查看了Foundation头文件中有关这方面的示例,但我认为他们必须做一些特别的事情.例如,NSXMLParserError是一个枚举,它在自动完成弹出窗口中显示文档字符串(如果您键入“NSXMLParserE”),但在NSXmlParser.h中,它在它之前的行上有一个普通的//注释.在我自己的代码中遵循此样式不会在弹出窗口中显示docstring.

解决方法

我找到了一种让它工作的方法,但它有点难看：

typedef enum: unsigned int {
    //! First letter
    ABC_A = 1,//! Second letter
    ABC_B = 2,//! Third letter
    ABC_C = 3,}
//! Now I know my ABC's.
abc_t;

我希望有一个解决方案,让我将文档字符串保持在声明之上,就像在其他所有上下文中一样.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!