Fork me on GitHub

swift的文档注释

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

swift的中有两种注释方式,让Xcode在Quick Help中显示。这种注释可以认为是将文档以某种规范的格式嵌入在实际代码的上方,这样就可以通过某些工具自动生成漂亮的文档文件。这种内嵌式的文档在现代编程中是很普遍的。在swift中,这两种注释方式是:

  • /** */
  • ///

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

可以支持markdown

关键词

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

参考

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

坚持原创技术分享,您的支持将鼓励我继续创作!
  • 本文标题: swift的文档注释
  • 本文作者: AndyRon
  • 发布时间: 2017年07月14日 - 00:00
  • 最后更新: 2018年09月16日 - 17:05
  • 本文链接: http://andyron.com/2017/swift-document.html
  • 版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处!