小白Java笔记——注释

前言：Java语言是强类型的语言，包括两个含义：1.所有的变量必须先声明后使用；2.指定类型的变量只能接受类型与之匹配的值。
一、注释
（一）单行注释：使用//;
（二）多行注释：使用/* */;

public class CommentTest
{
  public static void main(String[] args)
  {
  /*这是多行注释
  Java语言很有意思*/
  System.out.println("Hello World ");
  //System.out.println("这一行不显示出来")；
} 
}

（三）文档注释
Java代码中添加了合适的文档注释，然后JDK提供的javadoc将文档注释提取成一种API文档。
API：应用程序接口。开发大型的软件时，通常会由很多人开发很多个类，为了使其他人可以容易的使用这些类，就用API文档说明这些类的具体功能，而不用知道这些类是怎么实现的。总得来说就是它详细说明了每个类、每个方法的功能及用法。
当然，javadoc文档只默认处理由public和protected修饰的类、方法、接口、成员变量、构造器和内部类的文档注释。
生成API文档操作：
1.编写一个Javadoc类：

package feng;
/**
*Description:
*<br>网站：<a href="www.baidu.com">小白Java系列均来自疯狂Java讲义</a>
*<br>Copyright (C) 2017-2017, Lunatic_fei
*<br>This program is protected by copyright laws.
*<br>Program Name:
*<br>Date:
*@author Lunatic_fei 1234@136.com
*@version 1.0
*/
public class JavadocTest{
/**
*简单测试成员变量
*/
protected String name;
/**
*主方法，程序的入口
*@param args 这是调用函数
*/
 public static void main(String[] args)
 {
 System.out.println("Hello World!");
}

}

2.编写一个Test类

package kuang;
/**
*Description:
*<br>网站：<a href="www.baidu.com">小白Java系列均来自疯狂Java讲义</a>
*<br>Copyright (C) 2017-2017, Lunatic_fei
*<br>This program is protected by copyright laws.
*<br>Program Name:
*<br>Date:
*@author Lunatic_fei 1234@136.com
*@version 1.0
*/
public class Test{
 /**
 *简单测试成员变量
 */
 public int age;
 /**
 *Test 类的测试构造器
 */
 public Test(){
 }
}

使用cmd命令：javadoc -d apidoc -windowtitle 测试 -doctitle 学习生成API文档 -header 我的类 *Test.java
说明：其中*Test.java使用的通配符“ * ”意思是找到所有名字有XXTest.java的源文件（所以如果是Test1.java就不可以）。
**出现的错误：**
1. 错误: 编码GBK的不可映射字符
解决问题：编辑时，我是用的是subline,并没有进行对其配置,导致编码类型不匹配，所以为了方便，直接重新用的记事本一遍，问题解决；
2.错误: 需要class, interface或enum
解决问题：出现的一个非常低级的问题，在写Test类时，写成了public Test｛｝
`，正确的是public class Test｛｝，特别写出来，以后不会再犯；
3.错误: 未知标记: auther
* @auther Lunatic_fei 123456@136.com
^
解决问题：同样是一个低级问题：作者author拼写错误，相信以后不会再写错了；
4. 警告: args没有 @param
解决问题：查了一下百度，只要在主函数上加一行*@param args，即可。即使不加也可以生成API文档。

使用包结构存放的方法：

javadoc -d apidoc  -windowtitle 测试 -doctitle 学习 -header 我的类 -version -author feng lee