iOS之命名規範 編碼規範

2021-08-03 14:53:06 字數 3885 閱讀 6227

遵守規範也是讓**更清晰明了,易讀,易用,易維護,可以更好的適應團隊開發。自己看著也是賞心悅目,何樂而不為呢。

簡單明瞭的命名最好,不要用單詞的簡寫,盡量用單詞的全稱。可以看看蘋果的api格式,仿照蘋果的命名,盡量用英文,而不是拼音。

比如方法名的功能型別的一致性,比如獲取某些資料 - (nsstring *)getname,- (nsstring *)getage 中的get;或者設定資料 - (void)setname,- (void)setage 中的set。統一方法名可以讓人一看這方法就知道是幹什麼用的,提公升開發效率。

類的命名是採用大駝峰原則,如

userloginviewcontroller

在實際開發中,一般會在類名前面加個字首:

oyuserloginviewcontroller

加統一字首方法如下圖:

設定完後,每次在建立類的時候會自動新增字首。

user → 使用者

login → 登陸

viewcontroller → 控制器

這個類的用途就一目了然了

其他例子:oyusermodel,oytitleview,oynetmanager。。。

應用級別的類名(需要在其他專案中用到的類),可以不使用字首或者使用自定義字首

即為:photobrowser或者xxphotobrowser

uiview+oyframe 或者 uiview+oyextension

前者是對uiview這個類做的擴充套件,oy是字首,frame算是具體化功能,對frame獲取。比較清晰。

後者也是對uiview這個類擴充套件,但是並沒有寫明具體功能,可以在裡面新增關於uiview的很多擴充套件。具體功能可以在.h檔案裡注釋。檔案較少易於管理。

二者的選擇看個人喜好了

方法的命名是採用小駝峰的原則,如

- (xxmodel *)modelwithdictionary:(nsdictionary *)dictionary;

此類命名可以模仿蘋果提供的api,看見方法名大概可以猜出開是做什麼的。注意引數名也是小駝峰式的。

**方法仿照蘋果api。

普通變數採用小駝峰原則,

nsinteger usercode;

成員變數要在前面需要加下劃線'_'

@inte***ce

viewcontroller ()

全域性變數我一般在末尾加個下劃線'_'

nsinteger usercode_;

常量(巨集、列舉、全域性常量、區域性常量等)

1. k + 大駝峰 kusercode

2. 字首 + 大駝峰 oyusercode

3. 單詞大寫加'_' user_code

typedef ns_enum(nsinteger, oylaunchimageadviewactiontype) ;

建立資料夾最好建立實體資料夾,找到工程目錄,建立相應資料夾並拖入工程。

資料夾命名使用相應模組的英文,首字母要大寫。

分享下xcode8的兩個注釋快捷鍵

- command + / 所選行會被注釋掉

- command + option + / 在方法名或變數名的所在行或上一行使用,會自動填充注釋段,可輸入方法引數的意思或者作用。

刪除多餘的空行

1.1 所有的方法之間空一行

1.2 所有的**塊之間空一行

刪除多餘的注釋

2.1 刪除不用的**

2.2 刪除沒有意義的注釋

刪除多餘的方法

3.1 如果有方法一直不會用到,請刪除(除工具類)

3.2 沒有執行任何業務邏輯的方法,請刪除或給予注釋

刪除多餘的資源或檔案

新增必要的注釋

5.1 所有 .h 檔案中的property 需要給出清晰注釋,非必要變數請勿防止出現在 .h檔案中

5.2 比較大的**塊需要給出注釋

5.3 所有自定義的方法需要給出注釋

5.4 所有**中出現的阿拉伯數字需要給出注釋

5.5 程式中出現加密/解密 邏輯的操作地方,需要給出注釋說明過程(無論是系統還是自定義)

盡量少用大段列印,非必要可以注釋或刪除,盡量消除警告(不影響程式正常執行)

整體**風格要統一

7.1 **後的』{『不需要獨佔一行

7.2 運算邏輯符和變數之間空一格

7.3 多用#pragma mark - ***講方法分塊,#pragma mark與下面的**之前不要空行

7.4 遵循一般**規範,多模仿蘋果api

1 下面所有規則對第三方類庫無約束

* 所有類、方法、屬性等命名,做到見名知意,採用駝峰式命名規則

* 根據資源型別或者所屬業務邏輯對專案資源進行分組,使得整個專案結構清晰明了

* 整個專案保持一種**書寫風格(這個風格由無錫團隊根據自己編碼習慣來定),讓你的**變的優雅!

2. 命名規範

* 所有類名稱以專案工程開頭命名,eg:「xp」、「zjg」、「sz」

* 針對不同檢視控制器,在末尾新增字尾,eg:

uiviewcontroller 字尾新增「viewcontroller」

uiview 字尾新增「view」

uibutton 字尾新增「button」、「btn」

uilabel 字尾新增「label"

3. 單頁**最好控制在800行以內,每個方法最好不要超過100行,過多建議對**進行重構

4. 相同的邏輯方法定義避免在多個地方出現,盡量將公用的類、方法抽取出來

7. 專案中所有group或者檔名稱(名字等),不要使用漢字命名,盡量使用英文命名,國內特有名詞可以使用拼音。

8. 專案中所有group都需要在專案目錄中存在乙個真實的目錄,group中的檔案與真實目錄中檔案一一對應。

9. 請在專案中寫必要**的注釋

10. 請多使用 #pragma mark - mark name 對方法進行分組 eg:

* #pragma mark - view lifecycle

* #pragma mark - view lifeterm

* #pragma mark - init methods

* #pragma mark - action methods

* #pragma mark - common methods

* #pragma mark - uiactionsheetdelegate

* #pragma mark - uiimagepickercontrollerdelegate

* #pragma mark - uitableviewdelegate methods

* #pragma mark - uitableviewdatasource methods

* #pragma mark - uiscrollviewdelegate methods

* #pragma mark - uitextfielddelegate methods

* #pragma mark - uitextviewdelegate methods

IOS編碼規範(命名規範)

一.命名規則 命名總則 1.使 用駝峰法命名,命名清晰明了,要做到 自描述,不能省略,部分cocoa通 用縮略詞能夠縮寫。objective c不 支援名字命名空間,所以某些命名要加項 目前綴區別。需要加字首的地 方 全域性變數,類名,全域性函式,category 每個類別,函式都必須新增字首 3....

Python編碼規範之命名規範

1 不要使用小寫字母 l el 大寫字母 o oh 或者小寫 i 作為單獨變數名稱。因為一些字型中,上訴字母和數字很難區分 比如 o和0,l和1 2 module應該採用全小寫,並且盡可能短的命名,可以在模組名中使用下劃線以提高可讀性。package應該採用全部小寫,並且也要盡可能短的命名,但不允許...

IOS 命名規範

小駝峰命名法 camelcase 第乙個單詞小寫字母開頭,其他單詞首字母大寫 大駝峰命名法 pascalcase 所有首字母大寫。命名規範 1 類名 協議名 遵循大駝峰命名法 2 常量 這裡的常量指的是巨集 define 列舉 enum 常量 const 等,使用小寫 k 作為字首,名稱遵循大駝峰命...