• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

Swift:文档注释

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

1. 基本知识

import UIKit


class A {
    var x: Int
    
/**
     这是summary:这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出
     
     这是discussion:用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行
     
     - 天气不错
     - 哈哈哈
     
     1. 你好
     2. 我不好
     
     ```
     var x = 10
     print(\(x))
     ```
     
     **粗体**
     
     *斜体*
 */
    func printHello(){
        print("Hello!")
    }
    init(x: Int) {
        self.x = x
    }
}

2. 有关函数的注释

import UIKit


class A {
    var x: Int
    
/**
     - Parameters:
       - item1: 这是x
       - item2: 这是y
     
     - Returns:
       - 返回一个String值
     
     - Throws: printHello会抛出异常
 */
    func printHello(x: Int, y: Int) throws -> String {
        return "\(x + y)"
    }
    
    init(x: Int) {
        self.x = x
    }
}

3. MARK、TODO和FIXME

import UIKit


class A {
    var x: Int
    
    // MARK: - 方法
    func printHello(x: Int, y: Int) throws -> String {
        // TODO: 还要输出
        return "\(x + y)"
    }
    
    // FIXME: 这个要加required
    init(x: Int) {
        self.x = x
    }
}


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap