咸鱼带你学Java—注释与API文档

一、注释:Comment

1.分类

单行注释：//
多行注释：/*    */
文档注释：/**    */

2.作用

① 对所写的程序进行解释说明，增强可读性。方便自己，方便别人
② 调试所写的代码

3.特点

①单行注释和多行注释，注释了的内容不参与编译。
  换句话说，编译以后生成的.class结尾的字节码文件中不包含注释掉的信息
② 注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档。
③ 多行注释不可以嵌套使用

二、Java API 文档　

API:application programming interface。习惯上：将语言提供的类库，都称为api.
API文档：针对于提供的类库如何使用，给的一个说明书。类似于《新华字典》

三.良好的编程风格

正确的注释和注释风格  

•  使用文档注释来注释整个类或整个方法。
•  如果注释方法中的某一个步骤，使用单行或多行注释。

正确的缩进和空白

• 使用一次tab操作，实现缩进
• 运算符两边习惯性各加一个空格。比如：2 + 4 * 5。

块的风格

•  Java API 源代码选择了行尾风格
  

上一篇：咸鱼带你学Java—第一个Java程序

下一篇：咸鱼带你学Java—关键字与标识符