iOS代碼塊

1.屬性註釋

屬性註釋 使用 /** 註釋*/ 的文檔註釋格式。 這種註釋相較於// 註釋的優勢是此屬性能夠在後面的引用時，在智能提示的下方顯示中文註釋

若是你不是在董鉑然博客園看到本文請點擊查看原文。

例如：

1 2 3 4

/** 回覆率*/ @property(nonatomic,strong)MTPoiCompareM *replyRate; /** 回覆速度*/ @property(nonatomic,strong)MTPoiCompareM *replySpeed;

在以後的調用時能夠看到以下效果

而且以後在維護寫完的代碼時，把光標點到該屬性時能夠在右側的quickhelp快速看到此屬性的解釋。

 

從實際的開發角度來看並非全部的屬性都須要添加註釋，只要是屬性名能從英文直譯或者簡單明顯的屬性 不須要添加屬性註釋

1 2 3 4 5

@property(nonatomic,copy)NSString *name; @property(nonatomic,assign) float  avgScore; @property(nonatomic,assign) int  dealid; @property(nonatomic,assign) float  price; @property(nonatomic,assign) int  feedbackNum;

　　

①經過屬性名沒法快速且明顯的瞭解該用途的屬性必須添加註釋,如index究竟是誰的index?可是存在下列特性的屬性必須添加註釋

②相似於狀態的標記可能有0，1，2三種狀況的要將幾種狀況的註釋一塊兒寫入

③屬性名的英文直譯沒法說清時

上面特色與下面的代碼逐條對應：

1 2 3 4 5 6

/** 頂部分類的下標*/ @property(nonatomic,assign) int  index; /** 項目類型 1是團購  2是券*/ @property(nonatomic,assign) int  type; /** 本行業平均數據*/ @property(nonatomic,copy)NSString *cateValue;

　　

這裏插播一下引入代碼塊的步驟。這裏統一一屬性註釋的代碼塊爲 /** <#註釋#>*/  快捷鍵爲xx

 

2.引入代碼塊的步驟

1.將橘色部分複製到項目中的任意一個位置。裏面部分會自動縮成一個塊如圖

而後選中這些 拖入 右下角的代碼塊中。

拖入後鬆手會顯示設置框,按要求設置

而後點擊done, 這個代碼塊就會存在Xcode中。

使用代碼塊的好處就是能夠在項目中敲出快捷鍵加回車就能立刻出現本身預置的代碼而且，按tab鍵能夠快速切換到一個個小塊進行編寫

 

3.方法集註釋

系統有一個自帶的方法集註釋代碼塊

可是這個是不帶分隔線的，若是要加分隔線 還須要在後面加上 mark - 再跟上註釋，有點麻煩

使用後能夠達到以下效果

現統一一下，給出代碼塊

#pragma mark - **************** <#輸入註釋#>  快捷鍵爲mark

之因此中間用****拉長是爲了不與下面的註釋一塊兒重疊在前面不易觀看

 

全部類的數據源方法 或 代理方法的方法集前面必須加上一行方法集註釋來作分隔。（代碼要求將某個類的幾個代理方法應該寫在一塊兒）

 

4.普通註釋

在項目中的某個地方的邏輯可能比較複雜或者是核心思想的代碼，這種地方應加上一些註釋做爲標註，也利於本身維護代碼，利於以後別人接手代碼。

例如：

現統一一下，給出代碼塊

// ------<#單行註釋#>  快捷鍵爲gg

 

5.優先級註釋

這個重點註釋能夠自定義， 我給出我標註重點的註釋的代碼塊以下，也建議你們能夠統一，便於查看

// $$$$$ 快捷鍵爲dd

通常寫在一個大項目中常常須要跳過去修改的地方，用法是在這行代碼後面快速敲上dd回車 變成這樣

 

有時候須要找他們的時候，只須要在項目搜索裏敲上就能快速定位

這裏也能夠設置優先級$$ 或$$$，重點或常出異常的地方都建議標註不須要吝嗇。

請點擊查看原文。 轉載請註明出處。