本文在這里整理了6種添加注釋的方法和9種添加標記的方法粘室。
注釋
/*! 按鈕1 */
@property(nonatomic,strong)UIButton * btn1;
/** 按鈕2 */
@property(nonatomic,strong)UIButton * btn2;
/// 按鈕3
@property(nonatomic,strong)UIButton * btn3;
@property(nonatomic,strong)UIButton * btn4;/**<?按鈕4 */
//按鈕5 (快捷鍵 cmd + /)
@property(nonatomic,strong)UIButton * btn5;
/* 按鈕6 */
@property(nonatomic,strong)UIButton * btn6;
前面4種加了特效,可以顯示出自己給屬性恨豁、方法嘀粱、成員變量等添加上去的描述激挪。后面2種辰狡,則不可以。個人尤其喜歡第四種灌灾,可以方便的添加很簡短的注釋搓译,無需換行悲柱,搭配一個御用code snippet的快捷鍵就更美了锋喜。
標記
1、6種主流標記
// MARK: ~~~~~~~~~~~~~~~~~~~~
// TODO: puti is not a tree
// FIXME: mirror is not a table
// !!!: it is empty at all here
// ???: why pm 2.5 is so high
#pragma mark - UITableViewDelegate (中間的 ‘-’ 號豌鸡,可以添加一條分割線)
2嘿般、3種非主流標記
#warning >>>>>>>>>>>>>>
#error <<<<<<<<<<<<<<
Breakpoint
標記,雖然可以快速的讓你找到對應的代碼所在涯冠,但是炉奴,最好有始有終,有添加就有刪除蛇更,在代碼修改的時候瞻赶,對應的標記要及時作對應的變動。而且每種標記的運用和表達的意思都要理清楚派任,切勿濫用砸逊。
劍本無錯,對錯在持劍之人掌逛。
最后师逸,附上一段檢測工程中部分標記的腳本。
KEYWORDS="TODO|FIXME|\?\?\?:|\!\!\!:"
find "${SRCROOT}" \( -name "*.h" -or -name "*.m" \) -and \( -path "${SRCROOT}/Pods/*" -prune -o -print0 \) | xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"