Java基础语法 （Java Doc）

Java基础语法

Java Doc

注释

1. 平时我们编写代码，代码量少时，可以看懂自己写的是什么，但当项目结构一旦复杂起来，我们就需要用到注释了

2. 注释不会被执行，是我们写代码的人看的

3. 书写注释是一个非常好的习惯 BAT

4. 平时写代码一定要注意规范

5. Java的注释有三种：

   ①当行注释

   ②多行注释

   ③文档注释

Doc

1. JavaDoc它是一种技术，它可以把一些注释信息生成一个帮助文档。
2. javadoc命令是用来生成自己API文档的
3. 参数信息

@author作者名

@version版本号

@since指明需要最早使用的jdk版本

@param参数名

@retrun返回值情况

@throws异常抛出情况

4. jdk帮助文档

5. 在线API帮助文档：Java SE 文档 - API 和文档 | Oracle 中国

   ​ https://docs.oracle.com/javase/8/docs/api/

6. 简单的类

package com.feng.base; // “/**enter” 类注释
/**
* @author feng
* @version 1.0
* @since 1.8
*/
public class Doc{   //  方法注释
   //属性
   String name; 
    /**
    *
    *@param name        //参数
    *@return            //返回值
    *@throws Exception  //抛出异常
    */
    
    //方法
    public String test(String name) throws Exception{
       return name;
   }
}

7. 小技巧：选当前类，show in Explorer.导航栏输入cmd打开窗口。右键属性修改字体。

8. javac

9. javadoc(java生成文档)，文档里可能有中文。设置编码

10. 编码encoding UTF-8，字符集编码charset UTF-8

11. Doc.java

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

13. 类里面多了许多文件，其中index.html首页里面有："程序包com.feng.base"详情
14. 命令行格式：javadoc 参数 Java文件
15. 学会查找使用idea生产JavaDoc文档
16. Java基础总结：注释，定义基础变量，知道常量，知道项目搭建及规范，知道包，知道文本怎么生成，把自己写的代码成为给别人也能读懂的东西。