/**
注释内容如果需要换行需要加空行
换行
无序列表
- 表1
- 表2
- 表3
1. item1
2. item2
3. item3
let a = "Hello"
*/
/// 另外一种注释
/// #
/// ## 一到6级的标题
/// *斜体1* _斜体2_
/// **粗体1** __粗体2__
/// [标题](地址) 超链接、
///  图片
func showMultilineComments() -> String {
let text = "text"
return text
}
/// 参数的域
/// - Parameter item1: item1
/// - Parameter item2: item2
/// - Parameters:
/// - item1: item1
/// - item2: item2
///返回的域
/// - Returns: result
/// 异常的域
/// - Throws: 具体的异常信息
///
func showKeywordsCommentsWithItem(item1: AnyObject?, item2: AnyObject?) throws -> String {
let text = "text"
return text
}
///算法
/// - Precondition: 前置条件
/// - Postcondition: 后置条件
/// - Requires: 必要条件
/// - Invariant: 循环不变量
/// - Complexity: 复杂度
/// - Important: 重要信息
/// - Warning: 警告信息
/// - Attention: 警告
/// - Note: 记录
/// - Remark: 评论
func mysteriousAlgorithm(object: AnyObject) {
return
}
/// - Author: 作者
/// - Authors: 作者们
/// - Copyright: 版权信息
/// - Date: 日期
/// - Since: 起始日期
/// - Version: 版本信息
func showMetaComments() -> String {
let text = "Hello"
return text
}
/*
- Road:
- Touring:
- Cruiser:
- Hybrid:
- Fixed:
- Freewheel:
- style:
- gearing:
- handlebar:
- frameSize:
- Remark: 高亮某内容
- SeeAlso: `create` 引用代码
// MARK: - 标记
// TODO: 将要完成的标记
// FIXME: 留给未来修改的标记
*/
Swift中的文档注释
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
- 文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
- 文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
- 文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
推荐阅读更多精彩内容
- 原创文章，欢迎转载。转载请注明：关东升的博客 前面说到Swift注释的语法有两种：单行注释（//）和多行注释（/....
- 0x01 最近在项目中要对api进行大规模重构，并且工具源码注释生成文档，比较swagger和spihx之后，觉得...
- 制作页面并为页面添加注释，大致思路如下： 按照页面模块进行划分，这是为了把内容进行分组，便于理解。 罗列数据。所有...
- 前言 代码注释对于一个开发者来说至关重要。可以很负责任的说，一个好的开发者一定要会写一手漂亮的代码注释。我曾经接手...
