在開發過程中,使用 command 給自己留下開發註解是常見的事情。

但如果想要做成給使用者 (caller )看的,或是你正在開發一個Library,可能需要經過封裝,所以使用者不會看到完整的原始碼時(或是原始碼資訊過多,你想要摘要給使用者)時,該怎麼用呢?

我們可以看到xcode原生有Quick Help 的功能。

對著一個method 按右鍵,可以開啟Quick Help 畫面(或是也可以用option + 點擊開啟)

Untitled

print 指令來說,可以看到這邊有一些使用說明。

如果想要對自己寫的method 提供一樣的參照資訊,使用的方式是在function defination 上面使用三條線的command /// 或是用block command 標記起來 /** */

Untitled

這當中也有一些撰寫的技巧,妥善地利用以下標籤,可以讓資訊分類得更清楚

Untitled

Untitled