interllij idea生成javadoc

無名 发表于: 2016-06-23   最后更新时间: 2016-06-23  
  •   0 订阅,936 游览

interllij idea生成javadoc

在工具栏中找到”Tools”,然后“generate JavaDoc”,会弹出”Specify Generate JavaDoc Scope”窗口,在这个窗口里你可以选择生成整个项目的或者某个模块的javaDoc。

乱码

如果注释是中文会报以下错误:错误: 编码GBK的不可映射字符。需要添加一个参数再告诉编译器自己使用的编码。但这段参数代码不会写,所以最终端google一下出来了。然后在Other command line arguments位置填写-encoding utf-8 -charset utf-8 这段参数代码。然后点击OK,就能正常的生成javadoc代码了。但是在这个过程中可能还会有一些警告,如果你的@param中的参数未标注参数说明的话,会出现警告,如果你认为这没关系,可以忽略。

常用命名参数

@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference 查看引用
@override 重写

更多Javadoc用法可以访问:百度百科官方文档

Javadoc注释的规范

附上Javadoc注释的规范,这才是本文的重点,${}的是变量,IDE会自动添加,当然也可以直接改为固定文字。

注释的规范如下:

1、文件注释标签:

/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2013</p>
* <p>Company: www.izhangheng.com</p>
* @author zhangheng
* @date ${date}
* @version 1.0
*/

2、类型注释标签(类的注释):

/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* <p>Company: www.izhangheng.com</p>
* @author zhangheng
* @date ${date}
*/

3、字段注释标签:


/** ${field}*/

4、构造函数标签:


/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

5、方法标签:


/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/

6、重写方法标签:


/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/

7、代表方法标签:

/**
* ${tags}
* ${see_to_target}
*/

8、getter方法标签:

/**
* @return ${bare_field_name}
*/

9、setter方法标签:

/**
* @param ${param} 要设置的 ${bare_field_name}
*/






发表于: 1年前   最后更新时间: 1年前   游览量:936
上一条: 如何理解函数式编程
下一条: Kerberos认证流程详解
评论…

  • 评论…
    • in this conversation
      提问