美文网首页
编码规范

编码规范

作者: An_Jun | 来源:发表于2017-07-26 16:52 被阅读12次

    Ⅰ、项目文件夹

    1、安卓按照MVP模式,iOS按照MVC模式对工程文件进行归类管理;

    2、项目文件夹、类名、变量名等不能使用中文进行命名;

    3、按照权责分门别类存放资源文件:每种类型的资源存放于独立的目录下:图片,声音,配置文件等等;

    4、同一功能需求,不要导入多个第三方库;

    Ⅱ 、类、方法、变量

    1、类名开头大写,方法和变量名以驼峰法命名;

    2、类的头部注释需要备注该类的功能;

    3、定义自己的 UI 基类;

    4、常量的声明注释放在常量名上方,在本类中声明的变量较少时,变量声明注释放在变量名上方,如果有较多的变量,则可将注释放在右侧;

    5、声明相关性较强的变量时,放在一起,相关性不同的两组变量之间间空出一行;

    6、将判断状态的常亮定义为枚举类型,增强代码的可读性;

    7、方法前要添加模板注释(功能、参数作用、作者、时间、版权信息)

    8、方法参数较多时,注意换行,增强代码的可读性;

    9、方法中逻辑性代码需要进行注释;

    Ⅲ、网络请求

    1、接收返回数据的控制器不存在时,收到后台返回数据回调直接return;

    2、页面刷新、按钮点击等操作,需要向后台发送数据时,注意避免重复发送请求;

    图解(转载自臭码农)

    相关文章

      网友评论

          本文标题:编码规范

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