Java的文档注释之生成帮助文档的实例
示例：
/**
* Title: Person类<br/>
* Description:通过Person类说明Java中的文档注释<br/>
* Company: ***
* @author ***
* @version 1.0
*/
public class Person {
/**
* 这个是Person类的构造方法
* @param name Person 的名字
* */
public Person(String name) {
//执行语句；
}
/**
* 这是read（）方法说明
* @param bookName 读的书的名字
* @param time 读书所用的时间
* @return 读的书的数量
* */
public int read(String bookName, int time) {
//执行语句；
return 1;
}
}
生成命令
person Mac$ javadoc -d . -version -author Person.java
注意Person.java路径名要正确。
效果：
其中index.html为主页，打开如下图：
以上这篇Java的文档注释之生成帮助文档的实例就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持小牛知识库。
-
开发准备 1、注册智齿客服账号 2、下载APP 3、开放平台接口（Open API），结合企业的二次开发，必要参数： app_key（由智齿进行生成，请联系智齿商务人员或售后人员） appid（由智齿进行生成，请联系智齿商务人员或售后人员） 目录 智齿科技产品主要分为智齿智能客服系统和智齿智能外呼系统，除了产品自身提供了强大的功能以外，还提供了完善的开放平台，包括完善的Open API、以及客服系
-
hi-nginx-java 在nginx中重新定义了servlet规范。该定义仅仅依赖于nginx处理http协议的流程。所以是先有http服务器，后有servlet定义。这一点跟传统的servlet概念正好相反。
-
TinyMCE是一个轻量级的基于浏览器的所见即所得编辑器，支持目前流行的各种浏览器，由JavaScript写成。功能配置灵活简单（两行代码就可以将编辑器嵌入网页中），支持AJAX。 另一特点是加载速度非常快，如果你的服务器采用的脚本语言是 PHP，那还可以进一步优化。最重要的是，TinyMCE是一个根据LGPL license发布的自由软件，你可以把它用于商业应用。
-
PhpDocumentor PHPDoc 是一个能从PHP代码生成 javaDoc 样式的 API 文档和用户指南。
-
Prettier 是一个能够完全统一你和你的同事代码风格的利器，强大的可配置选项完全可以满足你的需求，自动格式化代码。
-
Highlight.js 是一个可以给 pre 标签中的代码高亮的插件，highlightjs 不依赖于第三方 js 库，支持上百种语言高亮和几十种样式风格，它可以自动检测语言，完美兼容各种框架。