iOS代碼規範文檔

来源:http://www.cnblogs.com/kunggh/archive/2016/06/18/5596760.html
-Advertisement-
Play Games

文件命名規範: 1. 項目統一使用類首碼ZY。 2. 分類命名+後面統一使用ZYExtension,例:NSDictionary+ZYExtension.h,常用分類定義在內部並寫好文檔註釋。如果功能性分類內部方法較多可以考慮按功能命名。 3. model文件可按伺服器介面名或欄位名命名,view、 ...


文件命名規範:

  1. 項目統一使用類首碼ZY。

  2. 分類命名+後面統一使用ZYExtension,例:NSDictionary+ZYExtension.h,常用分類定義在內部並寫好文檔註釋。如果功能性分類內部方法較多可以考慮按功能命名。

  3. model文件可按伺服器介面名或欄位名命名,view、viewModel和controller文件可按功能命名。

  4. 切圖命名:home_menu_chat,->模塊_功能_具體名字,切圖命名很重要,這點可與美術溝通,讓他們直接命名好再給我們,可以大大提高開發效率,但千萬不要使用中文。

代碼規範:

  1. 分類方法以zy_開頭,可與系統或者第三方框架方法區分。

  2. 全局用到的字元串或者基本數據類型儘量定義成常量而不是用巨集。並且只在某一文件內部用到可用static修飾,並且不要暴露在.h文件。

  3. 巨集定義以ZY_開頭,並且統一大寫,以_為分隔標識。

  4. 類內部方法按功能劃分,統一使用#pragma mark <#xxxx#>劃分。

  5. 方法參數較多時,儘量換行讓其參數對齊,提高可讀性。 

  6. 方法屬性註釋儘量使用文檔註釋,可下載一個插件VVDocument.

  7. 定義成員變數必須遵循apple規範添加下劃線。

  8. 控制項和屬性儘可能使用懶載入創建,這樣就可以保證用到時再創建。註意使用了懶載入創建的就不要直接用下劃線成員變數名訪問了,應該用get方法訪問。

  9. 方法回調儘可能使用block回調,可提高代碼聚合度,但是要註意迴圈引用問題,建議block內部都使用weak引用。

  10. 聲明字元串屬性必須使用copy,代理使用weak,不過儘可能少用代理吧,用block回調更方便。

  11. 註意方法和屬性、成員變數的駝峰標識命名。

  12. 析構函數- (void)dealloc最好放到類最上面,第一眼就可以看到這個方法,可以方便看到是否清空資源。

  13. 單個方法代碼儘量不要超過100行,單個文件代碼不要超過800行,如超過了可以考慮進行重構優化。   

  14. 相同邏輯方法,或者多處用到的方法可以優先考慮抽成分類,其次考慮抽到一個工具方法類。

  15. 定義控制項或者控制器必須在後面加上控制項名稱,例如一個imageView->UIImageView *iconView,不要直接用UIImageView *icon。  

  16. 判斷YES/NO/nil 採用這種寫法

  17. 載入圖片建議自定義UIImage一個分類方法,例:[UIImage zy_imageNamed:@””]。能在改方法攔截,換膚可能會用到。

  18. 所有網路請求以request開頭。例: 返回結果用block並對應一個data模型,和error.當error有值時為請求錯誤。 建議使用的第三方框架: YYModel -> 字典轉模型框架,性能目前與主流的框架相比性能較好,而且使用方便。 YYCategories -> 提供一些常用的分類方法,可以大大加快開發效率。 YYWebImage -> 載入網路圖片框架,可以帶有動畫效果,比SDWebImage好用。 MJRefresh -> 下拉刷新控制項 AFNetworking -> 網路請求 Pop -> facebook動畫框架 SVProgressHUD -> HUD提示,一個單例類,全局共用,無需反覆創建消耗性能 Masonry -> 自動佈局框架 Realm -> 最近比較火的資料庫框架,據說性能秒殺coreData和sqlite,且學習成本很低。 ReactiveCocoa -> 函數響應式編程框架。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一:GIF(Graphics Interchange Format) 簡介GIF圖形交換格式是一種點陣圖圖形文件格式,以8位色(即256種顏色)重現真彩色的圖像。 它實際上是一種壓縮文檔,採用LZW壓縮演算法進行編碼,有效地減少了圖像文件在網路上傳輸的時間。 它是目前廣泛應用於網路傳輸的圖像格式之一。優 ...
  • ...
  • 一.概述 * 鬧鐘功能概述:添加鬧鐘,刪除鬧鐘 * 思路: * 1.給一個button添加點擊監聽,用於添加鬧鐘 * 2.提供一個視窗進行鬧鐘時間的選擇 * 3.數據保存:對鬧鐘的數據進行保存 * 4.數據讀取:打開app的時候對鬧鐘的數據進行讀取,以便保留以前設置的鬧鐘 * 5.對鬧鐘進行刪除操作 ...
  • 【版權所有,轉載請註明出處。出處:http://www.cnblogs.com/joey-hua/p/5597705.html 】 Linux內核因為使用了記憶體分頁機制,所以相對來說好理解些。因為記憶體分頁就是為了方便管理記憶體。 說到記憶體分頁,最根部的要屬頁目錄表了,head.h中: 然後再看head ...
  • “階段一”是指我第一次系統地學習Android開發。這主要是對我的學習過程作個記錄。 最近學到用AsyncTask來處理有關網路的操作。雖然代碼看上去不是很複雜,但仍有很多地方有疑惑。所以研讀了一下API文檔,在這裡把我學到的和練習的代碼展示出來。如有錯誤,歡迎指出! 一、關於AsyncTask的< ...
  • 接著上篇《Android 採用get方式提交數據到伺服器》,本文來實現採用post方式提交數據到伺服器 首先對比一下get方式和post方式: 修改佈局: 添加代碼: ...
  • 【版權所有,轉載請註明出處。出處:http://www.cnblogs.com/joey-hua/p/5596830.html 】 上一篇說到進程調度歸根結底是調用timer_interrupt函數,在system_call.s中: 前面一堆push指令保存當前的寄存器,然後在ret_from_sy ...
  • 首先搭建模擬web 伺服器,新建動態web項目,servlet代碼如下: 再新建一個jsp頁面 新建android項目,頁面佈局: 代碼如下: 添加許可權:android.permission.INTERNET 運行項目後點擊按鈕後提示錯誤: 06-18 21:08:16.237: W/System. ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...