Eclipse中如何修改Java代码注释的样式和如何提取出注释文档

清疚 2022-05-21 09:58 179阅读 0赞

## 摘要 ##

习惯写注释不一定代表技术强，但是一个习惯写注释的程序员一定是个好程序员，至少写的代码美观，有益于后期维护。代码其实就是一种艺术品，如果有装饰的注释，那简直就是美上加美，让人赏析悦目。  
  我们都知道eclipse中可以快捷的为类，方法和数据域添加注释，方法为`/**+回车`，默认的样式为：  
![这里写图片描述][SouthEast]  
  很明显这个类注释只含有作者的信息，如果我们想为其添加类名、描述、创建时间、版本信息等，那该如何呢？

## 操作 ##

打开Eclipse，选择导航栏中Window->Perferences->Java->Code Style->Code Templates后，进入如下界面：  
![这里写图片描述][SouthEast 1]  
  其中Comments对应我们的注释模块，展开Comments:  
![这里写图片描述][SouthEast 2]  
  然后就可以看到一个Java源程序的各个组成部分，每个部分都有默认的注释模板，我这里就只演示类的注释模板，其他类似，选择Types后，选择右侧的菜单的Edit,之后就会出现编辑版。

#### 利用我的模板 ####

Copy以下格式(这是我喜欢用的，你也可以自行修改)放到编辑版中：

/**
     * @ClassName ${type_name}
     * @Description 
     * @Author Meng Yi
     * @Date ${date} ${time}
     * ${tags}
     */

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7

![这里写图片描述][SouthEast 3]  
  确定后，试验一下样式：  
![这里写图片描述][SouthEast 4]  
  还可以吧，如何自行添加呢。

#### 自行添加 ####

在编辑版中每一行都要以\*开头，然后@后面跟一个描述型单词，不一定非得用系统自带，也可以自行写，比如系统的author，后面跟的值为`${user}`,此user是个变量，我们可以在编辑版的中 insert variable里这个值，注意 insert variable里全是变量，关联项目或者系统。变量值必须放在`${}`中。  
如何修改作者信息呢？  
  user的值自动对应你的系统管理员的名字，如果你想修改为其他，就把$\{user\}删掉，然后用自己想要名字替代，这是静态名字，即字符串。  
如何添加具体的时间呢？  
  `@date ${date} ${time}`即可。

## 提取注释文档 ##

Java提供一个很好的工具包，就是能把代码中注释抽取出来形成HTML文档，方便阅读，效果还不错！

### 方式一：doc窗口下 ###

我们在doc窗口下 cd 到我们 源程序的目录下，然后javadoc 程序名.java  
即可在当前目录下形成我们的要的文档。  
这里以这个类为例：

package com.study.mengyi.object;
    /**
     *
     * @ClassName Test1
     * @Description
     * @Author Meng Yi
     * @Date 2017年7月13日 下午10:05:49
     */
    public class Test1 {
        
        int x;
        char y;
        public static void main(String[] args){
            Test1 test1 = new Test1();
            System.out.println(test1.x);
            System.out.println(test1.y);
        }
    }

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18

doc窗口下cd 到本程序的路径  
![这里写图片描述][SouthEast 5]

### 方式二 Eclipse ###

project->generate javadoc  
![这里写图片描述][SouthEast 6]  
finish即可，然后我们就可以去找index,html看我们的注释文档了~  
![这里写图片描述][SouthEast 7]

效果还不错！

[SouthEast]: /images/20220521/de89318ef5cd41fba716a9720eb7883e.png
[SouthEast 1]: /images/20220521/7a964693d33c418499f335431ebc2d17.png
[SouthEast 2]: /images/20220521/2e705b1fe9a846de96aa148f01596006.png
[SouthEast 3]: /images/20220521/a18489dd0f594cdfa17c5d78cfc2fbc4.png
[SouthEast 4]: /images/20220521/c5bca9c2fcc24fb7a95ee174c690cf9a.png
[SouthEast 5]: /images/20220521/8e9cd2fb3ad4442db63b491099738012.png
[SouthEast 6]: /images/20220521/411f7db6d6a841248842e8986208b8f1.png
[SouthEast 7]: /images/20220521/424fff365e234673a6fbf5662ac4bb12.png