Swift 注释和文档_代码007(未授权)

本文介绍: 今天，我知道我写是什么，上帝和我知道明天，我知道这个代码什么意思，后天，我知道这是我写的代码，一周后，这TM谁写的代码，此时只有上帝才知道啥意思论代码注释的重要性。

今天，我知道我写是什么，上帝和我知道

明天，我知道这个代码什么意思，

后天，我知道这是我写的代码，

一周后，这TM谁写的代码，此时只有上帝才知道啥意思

论代码注释的重要性。

普通注释主要为了提示编码和阅读者，逻辑注释等作用，一般不会在文档中提示。

// 定义一个空字符串
var str = ""
// 修改str变量的值
str = "a new value"

/*
这里是多行注释
多行注释里也可以成对出现
/*
子注释
*/
*/

#warning("Needs to be refactored")
// some dodgy code here

#if !canImport(UIKit)
  #error("This framework requires UIKit!")
#endif
#error使用情况示例：SDK API key, 代码中必填信息提示，标记当前完成任务在哪里（以便下次接着开发）等情况。

/// 用户信息
struct UserInfo {
    /// 昵称
    var nickname: String
    /// 性别 ture: 男,  false: 女
    var isMale: Bool
}

/// 文档注释参考 【单行】
/// - parameter pram: 单参数
/// - returns : 返回结果是否成功 ture： 成功  false: 失败
///
/// 其他discussion 详细说明  // 【注意】必须隔一行
func singleLineComment(pram:String) -> Bool {
    print("注释参考")
    return true
}

/**
 文档注释参考 【多行注释】  // 【注意：必须新起一行】
 - parameter p1: The number of Llamas spotted on the trip
 - parameter p2: The number of Llamas spotted on the trip
 - returns: 返回结果字符串数组
 
其他discussion说明  // 【注意】同样必须隔一行
 */
func text(p1:String , p2:Bool) -> [String] {
    return [String]()
    
}

 /**
 # 支持markdown
 # 一级标题
 ## 二级标题也可以的
 注释参考2
 隔一行表示换行d
 
 三个”***"代表一条分割线
 ***
 ## 使用示例
 ```
 let result = testComment2(pram: "参数1", param2: true))
 ```
 
 ****
 - important:这个很重要
 - returns: 有返回值
 - parameter pram: The cubes available for allocation
 - parameter param2: The people that require cubes

 */
func testComment2(pram:String, param2:Bool) -> Bool {
    print("markdown支持")
    return true
}

struct Student {
    var name: String
    mutating func changeName(newName:String) {
        self.name = newName
    }
}

struct Class {
    var students: [Student] = []
    
    /// 添加一个学生
    /// - Parameter student: 学生``Student``
    mutating func insertStudent(_ student:Student) {
        students.append(student)
    }
    /// 引用方法 ``Student/changeName(newName:)``
    func test() {
        
    }
}

可以用/访问属性和方法，暂无法跨包,比如 Student/name。

# Run SwiftLint
START_DATE=$(date +"%s")
 
SWIFT_LINT="${PODS_ROOT}/SwiftLint/swiftlint"
 
# Run SwiftLint for given filename
run_swiftlint() {
    local filename="${1}"
    if [[ "${filename##*.}" == "swift" ]]; then
        # ${SWIFT_LINT} autocorrect --path "${filename}"
        ${SWIFT_LINT} lint --path "${filename}"
    fi
}
 
if [[ -e "${SWIFT_LINT}" ]]; then
    echo "SwiftLint version: $(${SWIFT_LINT} version)"
    # Run for both staged and unstaged files
    git diff --name-only | while read filename; do run_swiftlint "${filename}"; done
    git diff --cached --name-only | while read filename; do run_swiftlint "${filename}"; done
else
    echo "${SWIFT_LINT} is not installed."
    exit 0
fi
 
END_DATE=$(date +"%s")
 
DIFF=$(($END_DATE - $START_DATE))
echo "SwiftLint took $(($DIFF / 60)) minutes and $(($DIFF % 60)) seconds to complete."