Swift

函数的文档注释

2019-09-27  本文已影响0人  坤哥爱卿
//函数的文档注释

///求和【概述】
///
///将2个整数相加【更详细的描述】
///
/// - Parameter v1: 第1个整数
/// - Parameter v2: 第2个整数
/// - Returns : 2个整数的和
///
/// - Note :传入2个整数即可【批注】
///
func sum(v1:Int,v2: Int) -> Int{
    return v1 + v2
}

Option键选中方法名,显示如下注释:

文档注释.png
更多注释功能和格式参考:https://swift.org/documentation/api-design-guidelines/
上一篇下一篇

猜你喜欢

热点阅读