Swift注释整理

开启注释:

Snip20161104_181.png

Snip20161104_182.png

TAGS="TODO:|FIXME:"
echo "searching ${SRCROOT} for ${TAGS}"
find "${SRCROOT}" ( -name "**.swift" ) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).$" | perl -p -e "s/($TAGS)/ warning: $1/"

单行注释:

//注释内容

多行注释:

其起始标记为单个正斜杠后跟随一个星号 /*
终止标记为一个星号后跟随单个正斜杠 */
另外,Swift与OC不同的是Swift可以嵌套多行注释

文档注释1

/**
方法的含义描述
-* parameter path: 路径
-* throws: 抛出异常
-* returns: 返回值
*/

文档注释2

/// 方法的功能描述
/// - parameter a 参数a的含义描述
/// - parameter b 参数b的含义描述
/// - throws: 异常描述
/// - returns: 返回值描述

文档注释3

/// 方法的功能描述
/// * 描述1
/// * 描述2
/**
描述
描述
*/
/// - parameter a: 参数a的含义描述
/// - parameter b: 参数b的含义描述
/// - throws: 异常描述
/// - returns: 返回值描述

分组注释:

  • 如果打算对代码进行分组可以使用 // MARK: -方式

TODO:

// TODO: - 需要做

FIXME:

// FIXME: 解决bug

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,853评论 18 139
  • 协议 协议支持多继承 类 结构体 枚举都可以遵守协议 协议之间的继承 协议继承用于代理设计模式 代理属性,一般都是...
    iiNico阅读 946评论 0 8
  • 1.疮痂病 南方地区5~6月发病盛期; 北方桃园一般6月开始发病,7~8月发病率最高。 春季和初夏,果实近成熟期,...
    ec0dd6eefd56阅读 2,665评论 0 0
  • 1.婴童床品仓位上层不要放婴童浴巾,建议放婴童定型枕 2.右边床品挂样颜色太杂乱,应按上层商品颜色纵向,同色系出样...
    jiangran阅读 358评论 0 0
  • 陈羽凡白百何终于站了出来,向公众公开了离婚的现实。 明星也是普通人,除了拥有七情六欲,他们也会有普通人一样的烦恼,...
    拧巴哥阅读 527评论 0 1