Java基础之注释与API文档等

1.注释：Comment

• 分类：
  • 单行注释：//
  • 多行注释：/* */
  • 文档注释：/** */
• 作用：
  • 对所写的程序进行解释说明，增强可读性。方便自己，方便别人
  • 调试所写的代码
• 特点：
  • 单行注释和多行注释，注释了的内容不参与编译。换句话说，编译以后生成的.class结尾的字节码文件中不包含注释掉的信息
  • 注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现的该程序的说明文档
  • 多行注释不可以嵌套使用

2. Java API 文档

API：application programming interface。习惯上：将语言提供的类库，都称为api

API文档：针对提供的类库如何使用，给的一个说明书。类似于说明书

3.良好的编程风格

API在线文档

jdk8: https://docs.oracle.com/javase/8/docs/api/
jdk9: https://docs.oracle.com/javase/9/docs/api/overview-summary.html
jdk10:https://docs.oracle.com/javase/10/docs/api/overview-summary.html
jdk11:https://docs.oracle.com/en/java/javase/11/docs/api/index.html
jdk12:https://docs.oracle.com/en/java/javase/12/docs/api/index.html
jdk13:https://docs.oracle.com/en/java/javase/13/docs/api/index.html
jdk14:https://docs.oracle.com/en/java/javase/14/docs/api/index.html
jdk15:https://docs.oracle.com/en/java/javase/15/docs/api/index.html
jdk16:https://docs.oracle.com/en/java/javase/16/docs/api/index.html