首页 » iOS编程基础:Swift、Xcode和Cocoa入门指南 » iOS编程基础:Swift、Xcode和Cocoa入门指南全文在线阅读

《iOS编程基础:Swift、Xcode和Cocoa入门指南》8.4 快速帮助

关灯直达底部

快速帮助是关于某个主题的缩略文档,主题通常是个符号名。它与当前所选或插入点有关,如果快速帮助查看器打开了,那么它就会自动出现在快速帮助查看器中(Command-Option-2)。比如,如果你正在编辑代码,而插入点或所选内容位于CGPointMake中,那么CGPointMake的文档就会出现在快速帮助查看器中(如果查看器可见)。

如果在nib编辑器中选择了界面对象(编辑项目或目标的同时又在构建设置)并打开了快速帮助查看器,那么也可以使用快速帮助。

快速帮助文档还可以显示为一个弹出窗口,这样就无须使用快速帮助查看器了。选中某个词并选择Help→Quick Help for Selected Item(Command-Control-Shift-?)。此外,还可以按下Option键并将鼠标指针悬浮在某个词上,直到鼠标指针变成一个问号(这个词会变成蓝色,同时会有一个点下划线);然后按住Option键并单击这个词。

在编写Swift代码时,快速帮助是非常重要的。如果单击其类型已经推断出来的某个Swift变量的名字,那么快速帮助就会显示出推断出的类型(如图3-1所示)。这有助于理解编译错误和其他问题。

快速帮助文档还包含了链接。比如,单击Reference链接会在文档窗口中打开整个文档。

可以将自己编写的代码的文档加到快速帮助中。要做到这一点,请在声明前加上注释/**...*/(此外,还可以使用以///开头的单行注释)。可以在注释中使用Markdown格式(参见http://daringfireball.net/projects/markdown/syntax);使用Markdown是Xcode 7新增的功能。注释会变成快速帮助的描述部分;某些列表项(以*或是-开头,后跟空格的段落)会被特殊对待:

·以“Parameter[paramname]:”开头的段落会成为Parameters域的一部分。

·以“Throws:”开头的段落会成为Throws域的一部分。

·以“Returns:”开头的段落会成为Returns域的一部分。

比如,下面是带有前置注释的函数声明:

图8-2:将自定义文档添加到快速帮助中


/**Many people would like to dog their cats. So it is *perfectly*reasonable to supply a convenience method to do so:* Because it's cool.* Because it's there.* Parameter cats: A string containing cats* Returns: A string containing dogs*/func dogMyCats(cats:String) -> String {    return "Dogs"}  

注释起始处的两个星号表示这是个文档,注释的位置会自动将其关联到dogMyCats方法上。星号所包围的单词会被格式化为斜体;星号段落会变成无序列表;最后两个段落会成为特殊域。结果就是在代码中选中了dogMyCats后,其实现会显示在快速帮助中(如图8-2所示)。说明的第一部分也会显示在代码完成部分中(参见第9章)。