大佬教程收集整理的这篇文章主要介绍了Swift 文档注释规范,大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。
代码的结构和组织关乎了开发童鞋们的节操问题。明确和一致的代码表示了明确和一贯的思想。编译器并没有一个挑剔的口味,但当谈到命名,空格或文档,人类的差异就体现出来了。
NSHipster 的读者无疑会记得去年发表的关于文档的文章,但很多东西已经在 Xcode 6 中发生了变化(幸运的是,基本上算是变得更好了)。因此,这一周,我们将在此为嗷嗷待哺的 Swift 开发者们记录一下文档说明。
好了,来让我们仔细看看。
从 00 年代早期,Headerdoc就一直作为苹果首选的文档标准。从 Perl 脚本解析勉强的Javadoc注释作为出发点,Headerdoc 最终成为了苹果在线文档及 Xcode 中的开发者文档的后台引擎。
随着 WWDC 2014 的发布,开发者文档被翻修并进行了时尚的新设计,包含了 Swift 和 Objective-C 的切换。 (如果你看过任何新的 iOS 8 的在线 API,那你已经见过这个新设计了)
真正让人意外的是,文档的格式也发生了变化。
在 Swift 的代码里调用快速文档 (Quick Documentation)(⌥ʘ
)时 Headerdoc 没有正确解析注释:
文档注释通过使用/** ... */
的多行注释或///...
的单行注释来进行区分。在注释块里面,段落由空行分隔。无序列表可由多个项目符号字符组成:-
、+
、*
、•
等,同时有序列表使用阿拉伯数字(1,2,3,...),后跟一个点符1.
或右括号1)
或两侧括号括起来(1)
:
定义和字段列表跟 Xcode 里的快速文档弹出@L_675_25@显示的差不多,定义列表会更紧凑一些:
两个特殊字段用于记录参数和返回值:分别为::param:
和:returns:
。:param:
后跟的是参数的名称,然后是说明。返回值没有名字,所以:returns:
后就是说明:
代码块也可以嵌入到文档的注释里,这对于演示正确的使用方式或实现细节很有用。用至少两个空格来插入代码块:
当这个应用在整个类的时候看起来怎么样?事实上,看起来相当的不错:
import Foundation
///
-
顶
-
0
-
踩
-
0
-
猜你在找
查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
以上是大佬教程为你收集整理的Swift 文档注释规范全部内容,希望文章能够帮你解决Swift 文档注释规范所遇到的程序开发问题。
如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。