美文网首页
个人代码规范

个人代码规范

作者: 左先生丶丶 | 来源:发表于2016-01-18 09:55 被阅读68次

    注释

    1.属性:


    属性注释

    2.方法 (定义参数记得换行)


    方法注释及定义

    3.成员变量


    成员变量定义

    4.单行注释


    单行注释

    5.方法集注释

    方法集注释

    6.公共方法修改 (在注释写你修改的代码 便于其他成员识别)

    公共方法修改
    1. 代码注释
    Paste_Image.png

    8.大量代码块注释

    Paste_Image.png

    命名规则

    1.类名 首字母 大写 如多人开发建议 使用自己的姓名开头

    如: ZCBaseViewController

    2.方法 (方法首字母小写,方法中的参数首字母小写)

    - (instancetype) initWithDictionary:(NSDictionary *) dictionary;

    3.定义变量 (变量名小写字母开头)

    int count = 0;

    4.常量以小写字母k开头,后续首字母大写

    kScreenWidth

    分层

    Paste_Image.png

    解析:
    Classes: 总体目录

    • Category :存放类别
    • Main : 存放控制器、View、Model
    • Resource : 资源文件夹 存放plist 、json 等
    • Util : 存放自己封装的一个控件等
    • Vendor : 存放一些别人写的第三方 (不能用cocopods的)

    解析Main 文件夹

    Paste_Image.png

    主要包含
    Other
    Four
    Three
    Two
    Home

    Other (包含 自定义TabBar 、导航、控制器父类、宏等相关)

    Paste_Image.png

    Four、Three、Two、Home 都是tabBar 的控制器

    Paste_Image.png

    这里的主要架构 还是MVC
    Service 主要是 将 请求 和处理请求 的代码写在这块 减轻 控制器的负担。
    Other 存在他的下一级 控制器 以此类推

    注: 若有错误 ,请指出。谢谢!

    相关文章

      网友评论

          本文标题:个人代码规范

          本文链接:https://www.haomeiwen.com/subject/oqdkkttx.html