IOS基本代碼規(guī)范(附帶基本目錄結(jié)構(gòu))

一、基本目錄結(jié)構(gòu):

1消恍、FCKit:主要包含(FCBaseCell岂昭、動畫Kit、Category等)
2狠怨、FCBase:主要包含(FCBaseModel约啊、BaseVC、Tool等)
3佣赖、FCNetWork:主要包含(FCBaseRequest恰矩、等)
4、ThirdParts:(第三方的源碼)-- tip: 源碼少的憎蛤,需要自定義的可以用這種方式添加枢里,否則用Pod方式。
5、APPDelegate:(APPDelegate和相關(guān)類目)
6栏豺、具體模塊的文件夾:(Home彬碱、PersonCenter、More等)

二奥洼、基本編碼規(guī)范:(好的命名是基礎(chǔ)巷疼,不能因此而省略注釋~)

1、新建UIViewController灵奖、UITableViewCell嚼沿、Model都要繼承父類,便于引入頭文件瓷患、公用通用的方法骡尽。命名例子:HomeVC、HomeCell擅编、HomeModel
2攀细、方法、屬性爱态、宏的(命名谭贪、空格、換行锦担、注釋)例子:

方法的例子:(注釋快捷鍵是:command+option+/),"+"后面有個(gè)空格俭识,后面的”{“ 前面有個(gè)空格并且不要換行

/**
 *  判斷字符串是否含表情
 *
 *  @param string 原有字符串
 *
 *  @return 返回是否有標(biāo)題
 */
+ (BOOL)stringContainsEmoji:(NSString *)string {

}

屬性的例子:(特別需要提示的注釋可以用"http:///"在上面,否則可以直接寫后面洞渔,盡量保持注釋對齊)

/// 用戶id
@property (nonatomic, strong) NSString      *userId;
@property (nonatomic, strong) NSString      *urlString;         // 網(wǎng)絡(luò)的url
@property (nonatomic, strong) NSString      *loadHTMLURL;       // 本地的url

宏的例子:(按類型分類:UtilMacro.h套媚、SizeMacro.h、NotificationMacro.h磁椒、ThirdMacro.h等)

1凑阶、尺寸相關(guān)的宏一般用全大寫,下劃線分割
/// 主屏的寬
#define SCREEN_WIDTH [[UIScreen mainScreen] bounds].size.width
2、UtilMacro.h相關(guān)的一般是”k“開頭衷快,下劃線分割,可讀性強(qiáng)
#define kAnimation_Time 0.3f
2姨俩、ThridMacro.h相關(guān)的一般是”k“開頭蘸拔,可讀性強(qiáng)
#define kUmengKey               @"aaaaaaaaa" // 友盟key
#define kBuglyId                @"aaaaaddd"  // Bugly的id

循環(huán)、判斷的例子:(注意空格和換行)

  // 判斷語句环葵,注意空格调窍、換行   
    if (self) { 
    
    } else {
    
    }
    // 循環(huán)語句,注意空格张遭、換行
    for (NSString *itemStr in array) {
    
    }

Tip: 上面是最常用的規(guī)范邓萨,也是最簡單的規(guī)范,發(fā)現(xiàn)好多開發(fā)者對最基本的規(guī)范都不遵守。導(dǎo)致代碼很亂缔恳,看著很不爽宝剖。(感覺上面的規(guī)范只要遵守好,不至于代碼很亂)

以后有機(jī)會了歉甚,可能會增加些更多的代碼規(guī)范万细。(有時(shí)候過于復(fù)雜的代碼規(guī)范,可能會起到反作用)過猶不及~

長期維護(hù)的iOS開源項(xiàng)目:
https://github.com/zjjzmw1/XM_OC_TOOL

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末纸泄,一起剝皮案震驚了整個(gè)濱河市赖钞,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌聘裁,老刑警劉巖雪营,帶你破解...
    沈念sama閱讀 222,378評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異衡便,居然都是意外死亡献起,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,970評論 3 399
  • 文/潘曉璐 我一進(jìn)店門砰诵,熙熙樓的掌柜王于貴愁眉苦臉地迎上來征唬,“玉大人,你說我怎么就攤上這事茁彭∽芎” “怎么了?”我有些...
    開封第一講書人閱讀 168,983評論 0 362
  • 文/不壞的土叔 我叫張陵理肺,是天一觀的道長摄闸。 經(jīng)常有香客問我,道長妹萨,這世上最難降的妖魔是什么年枕? 我笑而不...
    開封第一講書人閱讀 59,938評論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮乎完,結(jié)果婚禮上熏兄,老公的妹妹穿的比我還像新娘。我一直安慰自己树姨,他們只是感情好摩桶,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,955評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著帽揪,像睡著了一般硝清。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上转晰,一...
    開封第一講書人閱讀 52,549評論 1 312
  • 那天芦拿,我揣著相機(jī)與錄音士飒,去河邊找鬼。 笑死蔗崎,一個(gè)胖子當(dāng)著我的面吹牛酵幕,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播蚁趁,決...
    沈念sama閱讀 41,063評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼裙盾,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了他嫡?” 一聲冷哼從身側(cè)響起番官,我...
    開封第一講書人閱讀 39,991評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎钢属,沒想到半個(gè)月后徘熔,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,522評論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡淆党,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,604評論 3 342
  • 正文 我和宋清朗相戀三年酷师,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片染乌。...
    茶點(diǎn)故事閱讀 40,742評論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡山孔,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出荷憋,到底是詐尸還是另有隱情台颠,我是刑警寧澤,帶...
    沈念sama閱讀 36,413評論 5 351
  • 正文 年R本政府宣布勒庄,位于F島的核電站串前,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏实蔽。R本人自食惡果不足惜荡碾,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,094評論 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望局装。 院中可真熱鬧坛吁,春花似錦、人聲如沸铐尚。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,572評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽塑径。三九已至,卻和暖如春填具,著一層夾襖步出監(jiān)牢的瞬間统舀,已是汗流浹背匆骗。 一陣腳步聲響...
    開封第一講書人閱讀 33,671評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留誉简,地道東北人碉就。 一個(gè)月前我還...
    沈念sama閱讀 49,159評論 3 378
  • 正文 我出身青樓,卻偏偏與公主長得像闷串,于是被迫代替她去往敵國和親瓮钥。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,747評論 2 361