[iOS]Xcode使用技巧之文档注释二

上篇文章([iOS]Xcode使用技巧之文档注释一),我介绍了基本的文档书写语法--Markdown,下面来介绍一下在写注释文档时的一些常见域的关键字:

1. Parameter

这个关键字主要是为一些方法的参数添加说明的,基本格式:

- parameter 参数名 说明

例如:

/**
 
 - parameter name: 姓名
 - parameter age: 年龄
 */
func SomeFunc3(name: String ,age: Int ) -> String {
    
    return "Parameters"
}

如果参数比较多的话,每个都要加上parameter,很麻烦,可以使用parameters关键字,不要忘记其后的冒号:

/**
 
 
 - parameters:
    - name: 姓名
    - age: 年龄
 */
func SomeFunc4(name: String ,age: Int ) -> String {
    
    return "Parameters"
}

/**

以上两种写法的效果是一样,会发现,在注释文档内多了一个域,关于参数说明的:

parameter

2. returns

这个是为返回值添加说明的,使用格式为:

- returns: 返回值说明

/**
 
 - returns: 返回值
 */
func SomeFunc5(name: String ,age: Int ) -> String {
    
    return "Parameters"
}

这时,文档会多个Returns的域:

returns

3. throws

异常抛出的关键字,格式:

- throws: 异常说明

/**
  - throws: 抛出异常
 */
func SomeFunc6(name: String ,age: Int ) throws -> String {
    
    return "Parameters"
}

throws

以上是三个比较重要的关键字,下面列举一些其他的关键字

4.其他关键字

算法相关:

/**
 
 - Precondition: 算法前置条件
 - postcondition: 算法后置条件
 - requires: 算法内容
 - invariant: 循环不变量
 - complexity: O(n^n)算法复杂度
 - important: 一些重要信息描述
 - warning: 警告
 - attention: 警告信息
 - note: 一些记录
 - remark: 一些评论
 */
func someFunc7(name: String) {
    
    
}

描述信息:

/**
 
 - author: LQQ 开发者
 - authors: 所有开发者
 - date: 16-07-29 11:07:21
 - copyright: 版权所有
 - since: 开始时间
 - version: 版本号
*/
func someFunc8(name: String) {
    
}

以上就是文档注释中常用的一些关键字,还有其他一些关键字,大家不仿查询尝试一下.