Swift:文档注释

本文档详细介绍了Swift编程中的文档注释,包括基本知识,如何为函数添加注释,以及使用MARK、TODO和FIXME进行特殊标记的方法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

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
    }
}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值