函数的文档注释

//函数的文档注释

///求和【概述】
///
///将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/
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 日更到现在100多天,感觉有点越来越力不从心了。 每天都得有话题来写,那天在盐田图书馆见到欢喜大神亦有同感。 这次...
    Maggielxx阅读 1,306评论 0 1
  • 昨天晚上突然之间感觉涌上心头,喝了些酒,这些天一直纠结烦躁,不清楚自己想要的是什么,最怕的就是自己突然钻了...
    小阿茜a阅读 1,153评论 0 0
  • 其实,我是一个什么事都喜欢憋在心里的人,不喜欢到处跟人乱讲,有人说,你憋久了心里就会很累,对啊,我也知道这样很累,...
    子豪同学c阅读 10,114评论 0 0

友情链接更多精彩内容