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