1. 程式人生 > >Swift 註釋格式使用技巧小結

Swift 註釋格式使用技巧小結

在之前的Xcode版本中使用註釋外掛 VVDocumenter 可以快速的根據上下文的環境生成相應的註釋格式,但是該外掛目前在 Xcode7 bate 版中並不太相容,這就需要我們瞭解一下原生的註釋格式怎麼書寫了,現總結以下自己使用的幾種格式與大家共同交流。

Swift 中的普通註釋與 Objective-C 中的一致,大概分為以下三種

  • // 單行註釋

  • / *  多行註釋  */

  • /// 標記註釋1 

  • /** 標記註釋2 */

針對於 Swift 中函式的原生註釋方法在此列舉幾個如下,使用好了可以讓別人更容易讀懂我們的程式碼功能以及具體的引數意義。

示例1:


示例2:

示例3:


示例4


Objective-C 的三種常用註釋介紹:

示例1


示例2


示例3



示例4:


最後再補充兩個標記註釋,可以便利的標記某一塊函式列表的功能,已便後續查詢維護對應的函式