swift的文档注释

作者: Andy_Ron | 来源:发表于2017-07-14 10:41 被阅读276次

在Xcode中Quick Help 为开发者提供方便快捷的简洁文档查看方式。option+点击查看弹框,option+command+2在检查器中查看。

关键词

  • 三个关键词: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/

欢迎您访问我的的微信公众号:欣欣向戎(微信号: andy_ron1587 )!

相关文章

  • swift的文档注释

    在Xcode中Quick Help 为开发者提供方便快捷的简洁文档查看方式。option+点击查看弹框,optio...

  • Swift基础

    Swift文档格式和注释方法 参考文档[https://blog.csdn.net/qq_14920635/art...

  • Swift中的文档注释

  • Java基础之单行、多行、文档注释

    单行 //我是单行注释 多行 /* 我是多行注释 */ 文档注释 /** 我是文档注释 */ 文档注释和单行、多行...

  • 2017-05-10

    单行注释、多行注释与文档注释的合理使用 单行注释、多行注释与文档注释的合理使用 单行注释:// 注释内容 多行注释...

  • swift的文档注释一览

    多行注释文档 方法/函数的注释 源信息注释 算法注释关键字 标签注释关键字 markdown注释 还可以插入图片

  • 【Java补充】 Java文档注释

    Java文档注释 4.9 文档注释 运行javadoc可以生成HTML文档。 以专用的定界符 /**开始的注释,可...

  • 注释

    -//单行注释 -/*多行注释*/ -/**文档注释*/

  • Swift 注释

    Apple官方关于文档注释的解释 附上一个例子 参数多的时候就可以用 - parameters Swift 里...

  • Swift学习-02-基础控件

    Swift 基础控件基础 在Swift中得注释方法 pragma mark 变为 // MARK:- 普通注释依然...

网友评论

    本文标题:swift的文档注释

    本文链接:https://www.haomeiwen.com/subject/kdtnhxtx.html