Xcode 之注釋和標記整理

本文在這里整理了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/"

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末豆混,一起剝皮案震驚了整個濱河市篓像,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌皿伺,老刑警劉巖员辩,帶你破解...
    沈念sama閱讀 211,265評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異鸵鸥,居然都是意外死亡奠滑,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,078評論 2 385
  • 文/潘曉璐 我一進店門脂男,熙熙樓的掌柜王于貴愁眉苦臉地迎上來养叛,“玉大人,你說我怎么就攤上這事宰翅∑” “怎么了?”我有些...
    開封第一講書人閱讀 156,852評論 0 347
  • 文/不壞的土叔 我叫張陵汁讼,是天一觀的道長淆攻。 經常有香客問我阔墩,道長,這世上最難降的妖魔是什么瓶珊? 我笑而不...
    開封第一講書人閱讀 56,408評論 1 283
  • 正文 為了忘掉前任啸箫,我火速辦了婚禮,結果婚禮上伞芹,老公的妹妹穿的比我還像新娘忘苛。我一直安慰自己,他們只是感情好唱较,可當我...
    茶點故事閱讀 65,445評論 5 384
  • 文/花漫 我一把揭開白布扎唾。 她就那樣靜靜地躺著,像睡著了一般南缓。 火紅的嫁衣襯著肌膚如雪胸遇。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,772評論 1 290
  • 那天汉形,我揣著相機與錄音纸镊,去河邊找鬼。 笑死概疆,一個胖子當著我的面吹牛逗威,可吹牛的內容都是我干的。 我是一名探鬼主播届案,決...
    沈念sama閱讀 38,921評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼庵楷,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了楣颠?” 一聲冷哼從身側響起尽纽,我...
    開封第一講書人閱讀 37,688評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎童漩,沒想到半個月后弄贿,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 44,130評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡矫膨,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,467評論 2 325
  • 正文 我和宋清朗相戀三年差凹,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片侧馅。...
    茶點故事閱讀 38,617評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡危尿,死狀恐怖,靈堂內的尸體忽然破棺而出馁痴,到底是詐尸還是另有隱情谊娇,我是刑警寧澤,帶...
    沈念sama閱讀 34,276評論 4 329
  • 正文 年R本政府宣布罗晕,位于F島的核電站济欢,受9級特大地震影響赠堵,放射性物質發(fā)生泄漏。R本人自食惡果不足惜法褥,卻給世界環(huán)境...
    茶點故事閱讀 39,882評論 3 312
  • 文/蒙蒙 一茫叭、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧半等,春花似錦揍愁、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,740評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽垛吗。三九已至凹髓,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間怯屉,已是汗流浹背蔚舀。 一陣腳步聲響...
    開封第一講書人閱讀 31,967評論 1 265
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留锨络,地道東北人赌躺。 一個月前我還...
    沈念sama閱讀 46,315評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像羡儿,于是被迫代替她去往敵國和親礼患。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,486評論 2 348

推薦閱讀更多精彩內容