Java杂谈之Javadoc生成及其get,set和构造函数的生成

小鱼儿 2022-08-10 16:44 171阅读 0赞

一、在定义公共类的属性的时候，我们一般都把其定义为private访问权限，这样就造成不是自己类不能访问。

所以一般我们会用get,set这两个方法进行调用和赋值，如下：

public class Man implements Cloneable {
    	private String name;
    	private int age;
    		
    	public String getName() {
    		return name;
    	}
    	public void setName(String name) {
    		this.name = name;
    	}
    	public int getAge() {
    		return age;
    	}
    	public void setAge(int age) {
    		this.age = age;
    	}
    }

但对于get,set这些代码不推荐自己写，因为那样很烦又容易错，所以不管在VS中还是在

Eclipse中，都有自动生成的方式。

在这里，我们只要在程序中右击->Sources->Generate Getters and Setters

会出来一个提示框，在里面会列举出你定义的所有属性，只要选择你需要的属性，勾选

其之前的复选框，然后点击确定即可。

二、对于构造函数：

其实我们不写构造函数，系统也会自动生成构造函数。

当我们需要写构造函数的时候，有以下几点注意：

1.构造函数并不一定都是public的，其访问修饰符完全可以自定义

2.构造函数是可以重载的，一般带参数的构造函数比较常见

(这边可以右击->Sources->Generate Constructing Using Fields)

点击之后，会出来一个提示框，勾选你需要的参数即可创建

三、在我们创建了这么多类之后，光看代码很容易产生混乱。所以能不能创建一个类似于说

明的文档，像一些.chm的说明文档一样，当然这是可以的，因为在开发中，这中说明文

不管对于开发者还是用户都是很好的参考文档，我们叫这种文档为javadoc

步骤:

1.我们选中我们要对其说明的对象(这边可以是类名或者属性名或者方法名)

2.右击->Source->Generate Element Comment

3.会出来/\*\* \* \*/这种形式，你只要在\*后面填写说明即可

![20140805180315203][]

4.在把所有的对象都设置好之后，点击菜单栏中的Project->Generate Javadoc

![20140805180430015][]

5.点击打开提示框，在javadoc command中，点击Configure进行配置，找到你安装jdk的

的位置，找到其中的bin文件夹，点击进去找javadoc.exe文件，确定即可

(这边有的同学找不到的话，在自己配置jdk的那个地方，找到JAVA\_HOME，然后进行文件

查找即可，像我的地址是：C:\\Program Files\\Java\\jdk1.7.0\_17\\bin\\javadoc.exe)

![20140805180734089][]

![20140805180817504][]

6.在Use standard doclet选项中，自定义生成到哪里就行

7.点击Finish，到你指定生成的目录中查找即可

像下图所示：

![20140805175842718][]

点击其中的index.html就能看到javadoc你之前写的各种说明了，下面只展示一部分：

![20140805180149125][]

至此，javadoc就生成成功了，你可以查看里面的任何内容和说明。

[20140805180315203]: /images/20220810/fd9e594e2bc24a239b2f557d95ff9cb1.png
[20140805180430015]: /images/20220810/a17da2e552174f70a03719565eb96dca.png
[20140805180734089]: /images/20220810/4a97cbd6e31c4eee855500284ae95b83.png
[20140805180817504]: /images/20220810/73b9daa6f30c45cab47a3fcef05027aa.png
[20140805175842718]: /images/20220810/71e14a37d2b84cd2aebc578731b2e200.png
[20140805180149125]: /images/20220810/b1bc204949d9431f94de0d4738c8cea5.png