善用#waring,#pragma mark 標記

  在項目開發中,咱們不可能對着需求一口氣將代碼都寫好。開發過程當中確定遇到諸如需求變更,業務邏輯溝通,運行環境的切換等這些問題。當項目大的時候,若是木有造成統一的代碼規範,在項目交接和開發人員溝通上將會帶來很大的麻煩。程序員

  #pragma mark -網絡

  這個標記在iOS開發中用得最多了。其實最主要的是用來進行標記的,固然也有註釋的做用在裏面。固然咱們也能夠用//,/* */等經常使用註釋來講明。可是用#pragma mark -不一樣的是能夠將整個文件的函數以相似分組的形式展示。當咱們點擊Xcode 導航欄上面的文件後面的列表時將會獲得如圖所示的界面:函數

這樣當其餘開發者查看此文件時,能夠清晰的看到整個函數分佈,也清晰的知道各個功能相關的函數。若是鼠標點擊其中的標記能夠直接跳到此標記的位置,很是的方便。當進行業務上溝通和調用時很是省時省力。用#pragma mark -還有一個好處就是在開發中咱們常常會實現其餘類的delegate,datasource,protocol等,若是咱們#pragma mark - UITableViewDelegate,當咱們用鼠標加上command點擊UITableViewDelegate會直接跳到這個delegate定義的地方,能夠方便的查看相關方法。我的對#pragma mark - 做用的理解是便於開發者之間相互交流。特別是多人的大項目時,若是你們都按各自喜愛隨便使用#pragma mark - 那麼對於項目開發和維護來講是很是災難性的。不只開發者本身不清楚本身的整個文件的結構,當其餘開發者進行接手開發時將是件很是頭大的事情。因爲objc函數命名時具備口語化的特色,函數一看名字就知道其要實現的功能,因此日常開發中只寫一些關鍵性說明的註釋,如bool變量的說明,業務處理的邏輯等。結合#pragma mark - 能夠很方便的讓其餘開發者理解。測試

#waring ui

  這個更加建議你們使用,Xcode默認支持了將#waring標記以編譯警告的形式顯示出來。在軟件開發中,你們都會用TODO,FIXME,XXX等特殊註釋。這些關鍵字也被不少IDE所支持。若是在代碼中加入#warning 此處須要修改 by james,在Xcode的編譯警告窗口中看到:spa

在開發中,咱們苦逼程序員的思惟不斷的被打斷,不斷的來回切換。好比業務邏輯未定,網絡請求地址切換,寫死代碼進行本地測試,項目聯調等操做。最蛋疼的時項目上線後忽然發現請求地址不對,本地含有寫死的測試數據或者咱們須要用到其餘項目模塊代碼時,臨時改動了別人代碼,但木有改回去。這種狀況就屬於重大項目事故了。一兩個不肯定改動,苦逼程序員或許會記住,可是多了以後,那直接是百分之一萬會被遺漏的。因此最好的方法是在你不肯定的業務,測試數據等地方標上編譯警告。以#waring 開頭寫下緣由,標記人,時間等說明信息。這樣在項目開發結束後,會有一個專門的時間去消除這些警告,以確保沒有遺漏的地方。代碼規範

  對於依然喜歡用TODO,FIXME,XXX的開發者來講能夠,設置下工程的"Build Phases",而後添加New Run Script Build Phase,添加如下代碼code

KEYWORDS="TODO:|FIXME:|XXX:"
find "${SRCROOT}" \( -name "*.h" -or -name "*.m" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"

這樣xocde就能夠將這些特殊標記以#waring的形式展示出來。blog

相關文章
相關標籤/搜索