一、命名規(guī)則
1剃毒、使用專業(yè)名詞病袄,如iOS不要寫成IOS或者ios;(這個真的強迫癥每次看到好多人寫錯心里真的有疙瘩赘阀,甚至好多大牛都寫錯益缠,嗚嗚~~~~(>_<)~~~~)
2、盡量使用美式英語拼寫確保和蘋果公司的API一致基公;
eg:var tintColor = "red"幅慌;NSString *userName = @"zhanglizzy";
2轰豆、使用駝峰式的描述性命名方式胰伍,為類,方法秒咨,變量等命名喇辽。類名的首字母應(yīng)該大寫掌挚,而方法和變量的首字母使用小寫字符雨席;
3、命名方式一定要能看出該名字是用來干嘛的吠式,可以選擇某些已被公認(rèn)的縮寫形式陡厘,eg:button可寫成btn,viewController可寫成VC特占;
4糙置、UI控件命名格式:控件名+控件類型,eg“用戶名文本框”:userNameLabel是目,“密碼輸入框”:passwordField谤饭;
5、具體參考蘋果官方文檔。
二揉抵、常量定義規(guī)范
1亡容、字符串常量定義規(guī)范:
接口URL、通知名等冤今,使用static let k… = “”命名闺兢;
Notification格式為: [Name of associatedclass] + [Did | will] + [UniquePartOfName] +Nofification(eg: UIKeyboardWillShowNotification);
2戏罢、公共常量定義在/ThankYou/Main/Common/Macro.swift文件中屋谭,用一個結(jié)構(gòu)體存儲對應(yīng)的常量。
三龟糕、間隔
1桐磁、方法的花括號以及其他花括號(if / else / switch / while等等)總是跟語句在同一行開始,新起一行結(jié)束翩蘸;(關(guān)于花括號的故事糾結(jié)了很久所意,現(xiàn)在堅持這么寫是看蘋果官方推出來的)如:
if user.isHappy {
//Do something
} else {
//Do something
}
2、方法之間應(yīng)該總是用一個空行進行分割以提高視覺及結(jié)構(gòu)上的清晰度催首。
四扶踊、使用標(biāo)記分類代碼塊
每類方法前做一個Mark標(biāo)記,以便于直接查看標(biāo)記的方法名郎任,而不用盲目的去查找秧耗,使整個目錄清晰明了。如:
// MARK: - lifeCycle
override func viewDidLoad() {
super.viewDidLoad()
setup()
}
// MARK: - private Method
funcsetup() {
}
// MARK: - clickAction
func clickAction() {
sendMessageRequest() {
}
// MARK: - Request
func sendMessageRequest() {
}
五舶治、注釋規(guī)范
1分井、在每個類前添加類的用途描述:
*@author zhanglizzy, 16-04-12 11:08:29
*
*@brief用戶數(shù)據(jù)單例
*
*@since 1.0
@interface UserSingleton : NSObject
2、方法注釋使用VVDocumenter插件注釋工具(可惜了現(xiàn)在Xcode8已經(jīng)不能使用插件了霉猛,嗚嗚)
3尺锚、屬性注釋使用@/**<注釋信息* /(可使用語句塊/**<<#注釋信息#>*/,這個很贊惜浅,在方法后注釋瘫辩,調(diào)用時可提示注釋的內(nèi)容)
六、適配規(guī)范
1坛悉、使用Masonry第三方框架進行界面適配(推薦使用)
2伐厌、可設(shè)置frame相對布局方式
七、控件的封裝
1裸影、封裝的控件必須獨立于框架挣轨,零耦合;
2轩猩、拋出的接口參數(shù)必須明確卷扮,簡明扼要荡澎;
3、注釋格式要規(guī)范晤锹,切帶使用說明衔瓮。
八、SVN使用規(guī)范
1抖甘、先更新热鞍,再提交;
2衔彻、涉及到大范圍更新提交時薇宠,操作之前先備份本地代碼;
3艰额、如需替換文件澄港,則必須先刪掉被替換文件,提交柄沮,然后添加新文件再提交回梧。
九、版本迭代要有清晰明確的版本紀(jì)錄
1祖搓、明確紀(jì)錄此次版本切割制作版本號狱意;
2、此次版本所包含新增功能拯欧;
3详囤、以及改動和修復(fù)的功能。
eg:
============== 1.1版本分界線=================
1镐作、獲取好友列表
2藏姐、BUG優(yōu)化
3、發(fā)件箱消息推送
4该贾、社交分享
5羔杨、留言接口調(diào)整
============== 1.1版本分界線==================