1. 程式人生 > >Objective-C對方法進行註釋的方法

Objective-C對方法進行註釋的方法

名字看著挺繞的哈,其實就是對某個自己建立的方法進行註釋,類似編寫java程式碼時的註釋javadoc一樣,可以自動形成規範性的方法說明。

我們對方法進行註釋時,最需要說明的就是方法的作用、方法的引數以及方法返回的結果,所以這裡也只說這三個標籤,其實很簡單,如下所示:

/**
 * @brief 通過兩個引數請求一個結果.
 *
 * @param valueOne 第一個引數.
 * @param valueTwo 第二個引數.
 *
 * @return 返回結果.
 */
- (NSString *)askForSomething:(NSString *)valueOne and:(NSString *)valueTwo;

我們宣告方法時,緊挨著方法名在其上方輸入上述的註釋。brief表示方法的介紹,param表示引數,如果有多個就多次使用標籤,這樣在顯示時也會顯示的更好看,return表示返回的結果。其實也可以不寫任何標籤,那樣也能顯示,但是就是簡單的文字,沒有格式了。

現在我們呼叫方法,然後在呼叫的地方對著方法名,按住option鍵,也就是alt鍵,再點選方法名,就會彈出方法的說明,這時就可以看到我們註釋的效果了:


這樣是不是很清晰明瞭。雖然在宣告方法時會做很多額外的工作,但是當代碼量大了以後,這樣做的效果就出來了,免得總是忘記各個方法是做什麼的,引數又是什麼,畢竟不能總是依靠起名嘛。

上面也說了,也有簡易版的註釋方式,如下:

/**
 * 通過兩個引數請求一個結果.valueOne表示第一個引數.valueTwo表示第二個引數.方法會返回一個結果.
 */
- (NSString *)askForSomething:(NSString *)valueOne and:(NSString *)valueTwo;

效果如下:


這樣呢其實也能達到說明方法作用的效果,屬於懶人模式,但依然比直接打兩個斜槓要靠譜,不過當引數多或者說明冗長的時候就比較難以直觀地理解了,看各人的選取吧。