Android开发规范:注释,作为一个Android程序员你还不会JetPack

在这里插入图片描述

类注释


  1. 示例

/**

  • 对类的描述

  • @author: 张三

  • @e-mail: xxx@xx

  • @time: d a t e {date} date{time}

  • @version: 1.0

*/

  1. 设置

在这里插入图片描述

方法注释


每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释。

在方法前一行输入**/**** + 回车,或者到AS中设置Fix doc comment(Settings → Keymap → Fix doc comment)快捷键,AS会帮我们自动生成模板,我们只需要补全参数即可。

/**

  • 对方法的说明

  • @param id 查询用ID

  • @return User实体类

*/

在这里插入图片描述

通用注释


对于注释,我们还可以设定注释模板,然后通过快捷输入的方式自动帮我们生成设定的注释内容。

这样可以在代码的任何地方快捷生成注释,提升编码效率。

在这里插入图片描述

File → Settings → Editor → Live Templates,

新建一个MyComment的Group,然后建一个叫cmt的缩写,输入模板内容。

这样我们在代码里面输入cmt然后敲回车,就会自动帮我们生成模板内容。

方法体内代码注释


  1. 对代码块注释

/***************** 说明 ******************/

  1. 对单行注释

// 说明

  1. 对多行注释

/*

  • 说明1

  • 说明2

*/

常量变量的注释


下面几种情况下的常量和变量,都要添加注释说明,优先采用右侧//来注释,若注释说明太长则在上方添加注释。

接口中定义的所有常量

公有类的公有常量

枚举类定义的所有枚举常量

实体类的所有属性变量

public static final int TYPE_DOG = 1; // 狗

public static final int TYPE_CAT = 2; // 猫

public static final int TYPE_PIG = 3; // 猪

private int id; // id

private String name; // 名称

private String sex; // 性别

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
img
img
img
img
img
img
img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录大纲截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且后续会持续更新

如果你觉得这些内容对你有帮助,可以添加V获取:vip204888 (备注Android)
img

总结

最后为了帮助大家深刻理解Android相关知识点的原理以及面试相关知识,这里放上相关的我搜集整理的24套腾讯、字节跳动、阿里、百度2019-2021面试真题解析,我把技术点整理成了视频和PDF(实际上比预期多花了不少精力),包知识脉络 + 诸多细节

还有 高级架构技术进阶脑图、Android开发面试专题资料 帮助大家学习提升进阶,也节省大家在网上搜索资料的时间来学习,也可以分享给身边好友一起学习。

一线互联网面试专题

379页的Android进阶知识大全

379页的Android进阶知识大全

网上学习 Android的资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。希望这份系统化的技术体系对大家有一个方向参考。

2021年虽然路途坎坷,都在说Android要没落,但是,不要慌,做自己的计划,学自己的习,竞争无处不在,每个行业都是如此。相信自己,没有做不到的,只有想不到的。祝大家2021年万事大吉。

mg-xsRNSXbV-1711917672691)]

网上学习 Android的资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。希望这份系统化的技术体系对大家有一个方向参考。

2021年虽然路途坎坷,都在说Android要没落,但是,不要慌,做自己的计划,学自己的习,竞争无处不在,每个行业都是如此。相信自己,没有做不到的,只有想不到的。祝大家2021年万事大吉。

本文已被CODING开源项目:《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》收录

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值