代碼的註釋經常被人忽略，以至於在後期維護的時候較爲困難。我們準備在XX項目開始之前制定一套規範的註釋體系，致力於達到就算維護人員改變也能快速上手的效果。
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回車 變成這樣
有時候需要找他們的時候，只需要在項目搜索裏敲上就能快速定位
這裏也可以設置優先級$$ 或$$$，重點或常出異常的地方都建議標註不需要吝嗇。
如果你不是在董鉑然博客園看到本文請點擊查看原文。 轉載請註明出處。