Java的文檔注釋之生成幫助文檔的實例
更新時間:2017年12月14日 09:06:01 作者:gdwkong
下面小編就為大家分享一篇Java的文檔注釋之生成幫助文檔的實例,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧
示例:
/**
* Title: Person類<br/>
* Description:通過Person類說明Java中的文檔注釋<br/>
* Company: ***
* @author ***
* @version 1.0
*/
public class Person {
/**
* 這個是Person類的構(gòu)造方法
* @param name Person 的名字
* */
public Person(String name) {
//執(zhí)行語句;
}
/**
* 這是read()方法說明
* @param bookName 讀的書的名字
* @param time 讀書所用的時間
* @return 讀的書的數(shù)量
* */
public int read(String bookName, int time) {
//執(zhí)行語句;
return 1;
}
}
生成命令
person Mac$ javadoc -d . -version -author Person.java
注意Person.java路徑名要正確。
效果:

其中index.html為主頁,打開如下圖:

以上這篇Java的文檔注釋之生成幫助文檔的實例就是小編分享給大家的全部內(nèi)容了,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
springcloud如何使用dubbo開發(fā)rpc服務(wù)及調(diào)用
這篇文章主要介紹了springcloud如何使用dubbo開發(fā)rpc服務(wù)及調(diào)用,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-01-01
SpringBoot3.x中spring.factories?SPI?服務(wù)發(fā)現(xiàn)機制的改變問題小結(jié)
spring.factories其實是SpringBoot提供的SPI機制,底層實現(xiàn)是基于SpringFactoriesLoader檢索ClassLoader中所有jar引入的META-INF/spring.factories文件,這篇文章主要介紹了SpringBoot3.x中spring.factories?SPI?服務(wù)發(fā)現(xiàn)機制的改變,需要的朋友可以參考下2023-05-05
Servlet3.0學(xué)習(xí)總結(jié)之基于Servlet3.0的文件上傳實例
本篇文章主要介紹了Servlet3.0學(xué)習(xí)總結(jié)之基于Servlet3.0的文件上傳實例,具有一定的參考價值,有興趣的可以了解一下2017-07-07
java大話之創(chuàng)建型設(shè)計模式教程示例
這篇文章主要為大家介紹了java大話之創(chuàng)建型設(shè)計模式教程示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-02-02

