Java语言概述-注释与API文档等

Posted 2021-06-15 犄角旮旯是程序媛吖

一、注释

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

二、Java API文档

API：Application Programming Interface，习惯上将语言提供得类库，都称为api

三、良好的编程风格

1.正确的注释和注释风格

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

2.正确的缩进和空白

>使用一次tab操作，实现缩进
>运算符两边习惯各加一个空格 例 2 + 4 * 5

3.块的风格

>Java API源代码选择了行尾风格
![](https://img2020.cnblogs.com/blog/1521510/202106/1521510-20210615094736645-2105930764.png)