您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

統一 iOS 團隊程式碼風格的四種有效做法

編輯:iOS 開發基礎

本文為投稿文章,作者:曉月(部落格)

我們團隊有二十人。大神各有自己的習慣,新人還沒形成風格,而我本人不同時期的風格也不一樣——加起來,程式碼就有了 n 種樣子。關於這件事,有一派認為每人風格各自統一就好,不必死扣小細節;另一派則採取嚴格標準,強制所有人的程式碼出自同一個模子,Google 就是代表。

我傾向前者偏後者一點。團隊內部若能統一風格、共用一套規範,不同人寫出來的程式碼可讀性基本一致,新人做完一個模組後再去接手別人的程式碼,無論開發或維護都更快上手,精力能留給更重要的事。此外,好的規範與習慣本身就能減少 bug,省下開發與測試的時間成本。

統一程式碼風格這件事,能難倒工程師嗎?顯然不能。

程式碼格式化(Code Format)

有人偏 K&R 風格,有人偏 BSD 風格;有人程式碼全黏成一塊,等號與逗號兩側不空一格。

可以採用 BBUncrustifyPlugin-Xcode 這類外掛,存檔時自動格式化:

// 喜歡K&R風格的小伙伴 // 將左括號留在前一行的末尾 if(1){     a=b; } // 在他保存程式碼的時候就自動變成BSD風格啦 // 左右括號都單獨占一行 if (1) {     a = b; }

除了括號位置,格式化時還能順手處理其他細節,例如 if 與括號之間補空格、等號兩側補空格。

程式碼範本(Code Template)

不同人對類的內部組織順序也各有主張。以我個人的 ViewController 為例,習慣是這樣排:

#pragma mark - def #pragma mark - override #pragma mark - api #pragma mark - model event  #pragma mark - view event #pragma mark - private #pragma mark - getter / setter

要統一結構,可以替常用類別做程式碼範本:Handle、Model、ViewController、TableViewController、View 等(範本製作教學可參考相關文章)。

多才多藝的 Panda 還替這些範本設計了統一的 LOGO:

程式碼片段(Code Snippets)

常用片段也加上縮寫快捷鍵:

例如單例,輸入 qsi 就會自動展開:

+ (instancetype)sharedInstance {     static dispatch_once_t __singletonToken;     static id __singleton__;     dispatch_once( &__singletonToken, ^{ __singleton__ = [[self alloc] init]; } );     return __singleton__; }

程式碼掃描(Code Scan)

某個方法行數過長、複雜度過高,透過專案靜態掃描就能發現(靜態掃描的討論可參考相關文章)。它還能揪出這些問題:

  • 潛在 bug ——空的 if/else/try/catch/finally

  • 未被使用的程式碼 ——無用的區域變數與參數

  • 過度複雜的程式碼 ——過高的循環複雜度、NPath 複雜度、NCSS

  • 冗餘程式碼 ——多餘的 if 與無意義的括號

  • 程式碼異味 ——過長的方法與參數列表

  • 不良寫法 ——反向邏輯、對傳入參數重新賦值

Script

為了讓安裝變簡單,可以把 Code Format、Code Snippets、Code Scan 打包成一個腳本:

#!/bin/bash CURRENT_DIR=$(cd "$(dirname "$0")"; pwd) PLUGIN_DIR="${HOME}/Library/Application Support/Developer/Shared/Xcode/Plug-ins/" PLUGIN_CONFIG_DIR="${HOME}/.uncrustify" SNIPPET_DIR="${HOME}/Library/Developer/Xcode/UserData/" TEMPLATE_DIR="/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/" # 安裝程式碼格式化外掛 mkdir -p "${PLUGIN_DIR}" sudo cp -rf "${CURRENT_DIR}/Plug-ins/UncrustifyPlugin.xcplugin" "${PLUGIN_DIR}" # 格式化外掛配置檔案移動 mkdir -p "${PLUGIN_CONFIG_DIR}" sudo cp -rf "${CURRENT_DIR}/uncrustify.cfg" "${PLUGIN_CONFIG_DIR}" # # 安裝程式碼範本 mkdir -p "${TEMPLATE_DIR}" sudo cp -rf "${CURRENT_DIR}/Templates" "${TEMPLATE_DIR}" # 安裝程式碼片段 mkdir -p "${SNIPPET_DIR}" sudo cp -rf "${CURRENT_DIR}/CodeSnippets" "$SNIPPET_DIR" # Clean cd "${PLUGIN_DIR}" rm -rf __MACOSX echo "\nPAPH Code Style successfuly installed! Please restart your Xcode."

示範專案裡附了配置好格式化風格的外掛,但只放了一個程式碼範本與一個單例片段,可在這裡下載:https://github.com/uxyheaven/XYStyle。

以上,就是我們團隊在統一程式碼風格上所做的嘗試。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved