swift的文档注释

在Xcode中Quick Help 为开发者提供方便快捷的简洁文档查看方式。option+点击查看弹框,option+command+2在检查器中查看。
[图片上传失败...(image-b25b9f-1539165254419)]
swift的中有两种注释方式,让Xcode在Quick Help中显示。这种注释可以认为是将文档以某种规范的格式嵌入在实际代码的上方,这样就可以通过某些工具自动生成漂亮的文档文件。这种内嵌式的文档在现代编程中是很普遍的。在swift中,这两种注释方式是:

  • /** */
  • ///
    这些注释中还可以有其他一些规范

可以支持markdown

关键词

  • 三个关键词:parameterreturnsthrows。这三个关键词会在最左边显示。
  • 还有一些关键词会被提取到description中作为一些特殊字段显示,其他都会在description正常显示:
    author, authors, copyright, date
    since, version
    attention, important, note, remark, warning
    bug, TODO, experiment
  • complexity*;
    precondition, postcondition, requires, invariant
    see

参考

http://swifter.tips/documentation/
http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容