上篇文章([iOS]Xcode使用技巧之文檔注釋一),我介紹了基本的文檔書寫語法--Markdown,下面來介紹一下在寫注釋文檔時的一些常見域的關(guān)鍵字:
1. Parameter
這個關(guān)鍵字主要是為一些方法的參數(shù)添加說明的,基本格式:
- parameter 參數(shù)名 說明
例如:
/**
- parameter name: 姓名
- parameter age: 年齡
*/
func SomeFunc3(name: String ,age: Int ) -> String {
return "Parameters"
}
如果參數(shù)比較多的話,每個都要加上parameter,很麻煩,可以使用parameters關(guān)鍵字,不要忘記其后的冒號:
/**
- parameters:
- name: 姓名
- age: 年齡
*/
func SomeFunc4(name: String ,age: Int ) -> String {
return "Parameters"
}
/**
以上兩種寫法的效果是一樣,會發(fā)現(xiàn),在注釋文檔內(nèi)多了一個域,關(guān)于參數(shù)說明的:
parameter
2. returns
這個是為返回值添加說明的,使用格式為:
- returns: 返回值說明
/**
- returns: 返回值
*/
func SomeFunc5(name: String ,age: Int ) -> String {
return "Parameters"
}
這時,文檔會多個Returns的域:
returns
3. throws
異常拋出的關(guān)鍵字,格式:
- throws: 異常說明
/**
- throws: 拋出異常
*/
func SomeFunc6(name: String ,age: Int ) throws -> String {
return "Parameters"
}
throws
以上是三個比較重要的關(guān)鍵字,下面列舉一些其他的關(guān)鍵字
4.其他關(guān)鍵字
算法相關(guān):
/**
- Precondition: 算法前置條件
- postcondition: 算法后置條件
- requires: 算法內(nèi)容
- invariant: 循環(huán)不變量
- complexity: O(n^n)算法復(fù)雜度
- important: 一些重要信息描述
- warning: 警告
- attention: 警告信息
- note: 一些記錄
- remark: 一些評論
*/
func someFunc7(name: String) {
}
描述信息:
/**
- author: LQQ 開發(fā)者
- authors: 所有開發(fā)者
- date: 16-07-29 11:07:21
- copyright: 版權(quán)所有
- since: 開始時間
- version: 版本號
*/
func someFunc8(name: String) {
}
以上就是文檔注釋中常用的一些關(guān)鍵字,還有其他一些關(guān)鍵字,大家不仿查詢嘗試一下.
