2024年最全Android修炼系列（八），你真的会写注释吗？(1)，字节跳动移动架构师学习笔记

最后我还整理了很多Android中高级的PDF技术文档。以及一些大厂面试真题解析文档。

Android高级架构师之路很漫长，一起共勉吧！

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

• 当回车的时候与标签首部对齐即可
  */
  public void test(){}

如果注释描述里需要包含一个列表，一组选项等，我们可以使用< li>标签来标识，注意标签后不需要空格，见下：

/**

• 第一句话是这个方法的简短摘要。
• 如果这个描述太长，记得换行。

• 如果多个段落可以这样

• 这是列表1
• 这是列表2...
• 同样回车后与标签对齐即可

*/
public void test(){}

@param 是用来描述方法的输入参数。注意在方法描述和tag 之间需要插入空白注释行。不需要每个参数param的描述都对齐，但要保证同个param的多行描述对齐。param 的描述不需要在句尾加标点。

/**

• 第一句话是这个方法的简短摘要。
• 如果这个描述太长，记得换行。
• @param builderTest 添加参数的描述，如果描述很长，

•                需要回车，这里需要对齐
  

• @param isTest 添加参数描述，不需要刻意与其他param

•           参数对齐
  

*/
public void test(String builderTest, boolean isTest){}

@return 是用来描述方法的返回值。要写在@param tag之后，与其他tag 之间不需要换行。@throws 是对方法可能会抛出的异常来进行说明的，通常格式为：异常类名+异常在方法中出现的原因。见下：

/**

• 第一句话是这个方法的简短摘要。
• @param capacity 添加参数描述，不需要刻意与其他param

•             参数对齐
  

• @return 描述返回值的含义，可以多行，不需要句号结尾
• @throws IllegalArgumentException 如果初始容量为负

•     <ul>
  

•     <li>这是抛出异常的条件1（非必须），注意<li>格式
  

•     </ul>
  

• @throws 注意如果方法还存在其他异常，可并列多个
  */
  public int test(int capacity){
  if (capacity < 0)
  throw new IllegalArgumentException(“Illegal initial capacity”);
  return capacity;
  }

@deprecated 用于指出一些旧特性已由改进的新特性所取代，建议用户不要再使用旧特性。常与@link 配合，当然@link的使用位置没有任何限制，当我们的描述需要涉及到其他类或方法时，我们就可以使用@link啦，javadoc会帮我们生成超链接：

/**

• 第一句话是这个方法的简短摘要。
• 如果这个描述太长，记得换行。
• @deprecated 从2.0版本起不推荐使用，替换为{@link #Test2()}
• @param isTest 添加参数描述，不需要刻意与其他param

•           参数对齐
  

*/
public void test(boolean isTest){}

@link 常见形式见下:

@code 用来标记一小段等宽字体，也可以用来标记某个类或方法，但不会生成超链接。常与@link配合，首次通过@link生成超链接，之后通过@code 呈现等宽字体。

/**

• 第一句话是这个方法的简短摘要。
• 我们可以关联{@link Test}类，随后通过{@code Test}类怎样怎样
• 也可以标记一个方法{@code request()}
• @param isTest 添加参数描述，不需要刻意与其他param

•           参数对齐
  

*/
public void test(boolean isTest){}

@see 用来引用其它类的文档，相当于超链接，javadoc会在其生成的HTML文件中，将@see标签链到其他的文档上：

/**

• 第一句话是这个方法的简短摘要。
• @param capacity 添加参数描述，不需要刻意与其他param

•             参数对齐
  

• @return 描述返回值的含义，可以多行，不需要句号结尾
• @throws IllegalArgumentException 如果初始容量为负
• @see com.te.Test2
• @see #test(int)
  */
  public int test(int capacity){
  if (capacity < 0)
  throw new IllegalArgumentException(“Illegal initial capacity”);
  return capacity;
  }

总结

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

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

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

获取](https://bbs.csdn.net/topics/618156601)**

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！