? 以前寫android程序，每寫一個函數(shù)或者類就添加對應(yīng)的注釋，后來領(lǐng)導(dǎo)讓生成api文檔，直接使用了eclipse的到處文檔功能，強大又方便，這次換作ios開發(fā)，我想肯定也有對應(yīng)的注釋，于是上網(wǎng)查找了一番，抄錄如下：

對于單行和多行注釋大家都再熟悉不過了，下面主要寫一下指令，也就是在編寫程序時按住alt鍵或者command鍵能夠顯示出來的注釋

1 @brief : 簡要注釋. appledoc中僅對屬性、方法有效，對類、協(xié)議 無效，會造成后續(xù)內(nèi)容解析失敗. 2 @param : 參數(shù)描述. 3 @return : 返回值描述. 4 @exception : 異常描述. 5 @see : 參見. 6 @sa : 參見. 同@see. 7 @warning : 警告. 8 @bug : 警告. 9 @name : 組名. 用于給成員們分組, 既文檔中Tasks區(qū)的子類別.

示例代碼如下：

1 @interface medexParseXML : NSObject 2 /** 3 @brief 傳入xml文件名稱和根節(jié)點的下一級節(jié)點的名稱得到該節(jié)點的xml字符串 4 @param xmlName xml文件名稱 5 @param nodeName 根節(jié)點下一級節(jié)點名稱 6 @return 返回節(jié)點對應(yīng)的xml字符串 7 */ 8 -(NSString*) getFileNodeXML:(NSString*)xmlName :(NSString*)nodeName; 9 10 /** 11 @brief 傳入xml字符串獲得下一級節(jié)點的xml字符串 12 @param xmlStr xml格式的字符串 13 @param nodeName xml字符串下一級節(jié)點名稱 14 @return 返回節(jié)點對應(yīng)的xml字符串 15 */ 16 -(NSString*)getStrNodeXML:(NSString*)xmlStr :(NSString*)nodeName; 17 18 /** 19 @brief 傳入xml字符串獲得該字符串包含的下一級節(jié)點的值 20 @param xmlStr xml格式的字符串 21 @param nodeName 下一級要獲取值的節(jié)點的名稱 22 @return 返回節(jié)點的值 23 */ 24 -(NSString*)getStrNodeXMLValue:(NSString*)xmlStr :(NSString*)nodeName; 25 26 /** 27 @brief 傳入xml字符串獲得對應(yīng)的屬性的值 28 @param xmlStr xml格式的字符串 29 @param AttributeName 要獲取的屬性的名稱 30 @return 返回與屬性對應(yīng)的值 31 */ 32 -(NSString*)getXMLAttribute:(NSString*)xmlStr :(NSString*)AttributeName; 33 @end

然后在編寫代碼時對某一個方法不清楚可以按下alt鍵彈出提示，如圖：

總結(jié)

以上是生活随笔為你收集整理的objective c的注释规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。