Swift中的文档注释

/**
    注释内容如果需要换行需要加空行

    换行

    无序列表
    - 表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: 留给未来修改的标记

 */

推荐阅读更多精彩内容