我给自己设定的Swift开发命名规则

▾    Swift开发命名规则    

    ▾    Class    

    •    界面控制器    XxxVC

    •    界面元素    XxxView

    •    界面控件(按照继承)    XxxControl, XxxButton, XxxLabel, XxxTextField

    •    网络/逻辑控制器    XxxManager

    •    网络/数据模型    XxxModel

    •    子模型/单一数据块/枚举    Xxx (不加后缀)

    ▾    Function    

    •    标准: 动词结构    xxx (动词)

    •    标准: 动词+宾语结构    xxxXxx (动词+宾语)

    •    全局函数    Xxx

    •    对象模型转换    toXxx

一个对象的模型, 转换为另外一个对象的模型

    ▾    事件函数    

    •    点击事件    onClickXxx

    •    数据更变事件    onUpdateXxx

    •    拖动事件    onDragXxx

    •    通知事件    onNoticeXxx

    •    递层事件    onXxx

指的是事件本身传递的事件, 比如登录动作, 界面上有一个Login按钮, 我们可以做一个onClickLogin然后执行登录动作, 之后, 我们增加了用户输入Enter按钮也可以登录, 于是将Enter动作绑定到onClickLoin, 再然后, 又加上了自动登录功能, 检查本地存储, 然后登录. 这样一直做下去, 整个逻辑会比较复杂, 这时候的正确做法是建立一个onLogin事件, 实现最标准的登录动作, 然后onClickLogin等等用户直接发生的事件, 在自己各自独立的处理动作之外, 在内部调用onLogin. 这个onLogin是一个事件, 但是并不是由用户动作而来, 而是由外部事件传递而来, 所以叫递层事件. 

    ▾    建模函数    

    •    界面建模    setup / setupXxx

为界面建立模型内容和填充数据

    •    模块建模    build / buildXxx

为对象建立内容

    •    模型传递    bind / bindXxx

在模型和模型之间自动传递内容, 一般用于Rx这样的地方. 

    ▾    Property    

    •    单例  static    shareInstance

    •    Build模式  static    build / buildXxx

    •    条件判断    isXxx

    •    格式转换    xxxValue

    •    类内部交换数据    xxx / xxxXxx 

必须加上private, 仅限于类的成员函数之间传递数据, 对外封闭

    •    类外部可用数据    xxx / xxxXxx

    ▾    Object    

    •    全局对象    g_xxxXxx

    •    静态对象    s_xxxXxx

    •    一般对象    xxxXxx

▾    项目定义规则    

    •    配置文件    Config

    •    资源文件    Resource

    •    3方库文件    ThirdParty

    •    逻辑代码    Logic

    •    ViewController    直接放在最外层

 

转载于:https://my.oschina.net/wyo/blog/838512