本文介绍了Java/Android开发者应遵循的代码注释规范，包括方法注释、模板使用、资源文件注释以及如何通过体系化的学习资料提升技能，避免技术停滞。还强调了长远职业规划的重要性。
- 示例
/**
-
对类的描述
-
@author: 张三
-
@e-mail: xxx@xx
-
@time: d a t e {date} date{time}
-
@version: 1.0
*/
- 设置
每一个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须做方法头注释。
在方法前一行输入**/**** + 回车，或者到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
-
说明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移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！
由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）
分享读者
作者2013年java转到Android开发，在小厂待过，也去过华为，OPPO等大厂待过，18年四月份进了阿里一直到现在。
被人面试过，也面试过很多人。深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，不成体系的学习效果低效漫长，而且极易碰到天花板技术停滞不前！
我们整理了一份阿里P7级别的Android架构师全套学习资料，特别适合有3-5年以上经验的小伙伴深入学习提升。
主要包括腾讯，以及字节跳动，阿里，华为，小米，等一线互联网公司主流架构技术。
如果你觉得自己学习效率低，缺乏正确的指导，可以一起学习交流！
我们致力打造一个平等，高质量的Android交流圈子，不一定能短期就让每个人的技术突飞猛进，但从长远来说，眼光，格局，长远发展的方向才是最重要的。
35岁中年危机大多是因为被短期的利益牵着走，过早压榨掉了价值，如果能一开始就树立一个正确的长远的职业规划。35岁后的你只会比周围的人更值钱。
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
一定能短期就让每个人的技术突飞猛进，但从长远来说，眼光，格局，长远发展的方向才是最重要的。
35岁中年危机大多是因为被短期的利益牵着走，过早压榨掉了价值，如果能一开始就树立一个正确的长远的职业规划。35岁后的你只会比周围的人更值钱。
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
