在網路上已經有很多人分享各種 Objective-C 的程式碼風格,例如 NYTimesGitHubRay Wenderlich,我相信各位讀者公司應該也有一套自己的規範(如果沒有,那請趕快制定一套吧!),所以今天我不是要分享我們的程式碼規範,而是要來說說要怎麼將不符合規範的程式碼轉成合乎規範。

我研究了一些程式碼美化的工具,最後選用的是 BBUncrustifyPlugin-Xcode 這個 Xcode plugin,它最早只有支援 Uncrustify,最近也開始支援 ClangFormat 了,我個人是比較偏好 Uncrustify,因為它可以調整的選項比較多。

它需要一份設定檔,設定檔的名稱與存放位置有其規定,引用自官方文件:

Uncrustify configuration: The configuration file must be located in the current directory or any parent directories of the source file. The file is named .uncrustifyconfig or uncrustify.cfg. Uncrustify looks for the configuration in the additional folders: Home Folder and ~/.uncrustify/uncrustify.cfg.

這是我的 uncrustify.cfg 設定檔,我把它放在個人家目錄底下,當然你也可以考慮把它放在專案目錄下並加到版本控制系統裡,讓這個專案的參與成員們都能有一致的程式碼風格。

當然每個人的風格都不一樣,需要的設定也都不同,我推薦可以使用 UncrustifyX 這個 GUI 來調整個別設定。因為可以設定的選項實在是太多了,所以找出適合自己設定的過程其實還挺累的,但我覺得這個過程是值得的,累一次之後就輕鬆了。

當你安裝好 BBUncrustifyPlugin-Xcode 這個 Xcode plugin 之後,你會發現它無法設定快速鍵,每次都得用滑鼠去點選單實在是一件很沒有效率的事情。沒關係,我們可以透過 Mac 內建的快速鍵設定來為選單加上快速鍵。請看下圖:

快速鍵設定

希望這篇文章能幫助到各位,讓大家都能擁有一致的程式碼風格:)

 

, ,

Nelson 發表在 痞客邦 PIXNET 留言(0) 人氣()