JavaSE—程序结构、注释

1.Java程序结构

Java是面向对象的程序设计语言，主要是以类的形式存在，类是Java程序的最小单位，即所有的执行语句都在类里编写。

在IDEA里new一个名为Hello的Java class，会自动生成如下内容：

//最简单的Java程序
//public是一个权限修饰符

public class Hello{
}

这是一个空类（类里面什么内容都没有），这样的类在IDEA里会发现不能运行，因为它没有包含一个Java程序需要的“入口”：main方法（每一个类有且仅有一个）。

public class Hello {
    public static void main(String[] args) {
    }
}

此时可以运行，但是是没有任何的结果的。

2.注释

注释呢就是写在代码中的解释，写注释不仅方便了自己以后回看代码（永远不要对自己盲目自信，不写注释以后很大可能你自己也看不懂你自己写的代码了），团队开发的时候也方便他人阅读你的代码，而且可以通过注释快速的知道代码的逻辑、功能等等。

所以一句话，写注释，方便你我他。

当然，注释也不是随随便便就瞎写的。。。

Java的注释分为三种：单行注释、多行注释、文档注释

//单行注释

    /*
    多行注释1
    多行注释2
     */

 /**
     *文档注释
     *包含很多参数
     *像在类上的：@author（作者）,@version（版本）,@since（最早使用的JDK版本）等
     *在方法上的：@param（参数）,@return（返回值）,@throws（异常）等
     *
     *例：方法的参数为args
     * @param args
     */

文档注释是可以生成一份API文档出来的：

/**
 * @author denghui
 * @version 1.0
 * @since 1.8
 */
public class JavaDoc {
    public static void main(String[] args) {
    }

    /**
     * 
     * @param name
     * @return
     * @throws Exception
     */
    public int javaDoc(String name) throws Exception{
        return 1;
    }
}

在上述中，书写了一些简单的注释，我们可以通过命令行来生成一份自己的API文档：

1. 在Dos窗口进入到所需要生成JavaDoc文件的源程序所在的文件夹目录下；

2. 使用命令；

javadoc [参数] 目标Java文件

//具体有哪些参数可以使用javadoc -help命令查看

3.生成了很多的文件，打开index.html，即为API文档：

在IDEA中也是可以直接生成文档的：

然后选择生成路径，和添加参数。

---

注释可以写在任何的位置，一般写在想要解释的代码之上，注释是不会被执行的！

网上有很多有才之人脑洞大开的写了很多有趣的注释，佛祖、狗头、神兽......通通都来了

/***
     *      ┌─┐       ┌─┐
     *   ┌──┘ ┴───────┘ ┴──┐
     *   │                 │
     *   │       ───       │
     *   │  ─┬┘       └┬─  │
     *   │                 │
     *   │       ─┴─       │
     *   │                 │
     *   └───┐         ┌───┘
     *       │         │
     *       │         │
     *       │         │
     *       │         └──────────────┐
     *       │                        │
     *       │                        ├─┐
     *       │                        ┌─┘
     *       │                        │
     *       └─┐  ┐  ┌───────┬──┐  ┌──┘
     *         │ ─┤ ─┤       │ ─┤ ─┤
     *         └──┴──┘       └──┴──┘
     *                神兽保佑
     *               代码无BUG!
     */