1. 程式人生 > >使用javadoc生成專案的幫助文件

使用javadoc生成專案的幫助文件

專案的幫助文件更有利於他人對專案的使用。

可以通過cmd命令列和exlipse整合的javadoc功能兩種方式製作幫助文件。

cmd命令方式,是使用的是jdk自帶的工具,javadoc。開啟cmd,如果沒有為jdk的bin路徑建立環境變數,不可以在任意路徑使用javadoc命令,需要到bin目錄下使用javadoc命令。

對於一般的製作需求的命令格式是:

javadoc  -d  輸出幫助文件的目錄  -author  -version  -encoding  原始檔編碼集  -charset  跨平臺檢視的編碼  -docencoding    輸出的編碼集

注意,一般java用於開發web專案,預設的編碼集都是utf-8的,所以,需要指明原始檔的編碼集,否則與系統預設的GBK編碼衝突,到底是否是utf-8還有視具體情況而論。

例如:javadoc  -d  e:\doc  -author  -version  -docencoding  UTF-8  -charset  UTF-8  -encoding  UTF-8  E:\eclipseworkspace\hello\src\com\tenn\java\xxx.java

關於javadoc更詳細的引數,執行javadoc  -help檢視。

exlipse中的方式是,file>export>java>javadoc>配置javacdoc命令的檔案路徑(其實也是使用jdk的javadoc工具)>選擇要為哪個或哪些檔案生成幫助文件>next>next>在extra  javadoc  options中設定字元編碼,基本也是在命令列中設定的引數  -encoding  UTF-8  -charset  UTF-8>finish。

相關推薦

Java使用Javadoc生成說明幫助

寫這篇文章完全是一時興起,因為在此之前,我其實也並沒有使用過 Java Doc 的功能。但是即使很少使用得到,但是你不得不承認,如果公司的API能夠整理出這麼一套API,我想每一個剛入職的員工都會對它愛不釋手的。 程式碼中註釋的使用 1. 首先看一

javadoc命令生成api幫助

到http://www.eclipse.org/swt下載了最新的swt包。可惜包裡只有原始碼,沒有api幫助文件。如果要學習的話,少了幫助文件哪能行,於是就用javadoc命令自己製作了一個。具體操作如下: 1.準備工作。 將下載到的swt-3.5.2-win32-win

Sphinx 生成 Windows 幫助 (.chm)

點擊 pro HR image lib absolute sphinx pen 開發 本文不介紹 Sphinx 的用法,只簡要羅列 Windows 下生成 .chm 文件的步驟。 0. 首先檢查機器是否安裝了 HTML Help Workshop 軟件,一般安

Ant生成Java幫助doc

程式碼總覽 Student.java package com.itlwc; /** * 使用者管理物件 * * @author Lwc */ public class Student {

使用javadoc生成專案幫助

專案的幫助文件更有利於他人對專案的使用。可以通過cmd命令列和exlipse整合的javadoc功能兩種方式製作幫助文件。cmd命令方式,是使用的是jdk自帶的工具,javadoc。開啟cmd,如果沒有為jdk的bin路徑建立環境變數,不可以在任意路徑使用javadoc命令,

使用eclipse生成javadoc幫助

方式一: 1.首先,開啟Eclipse,在需要生成Javadoc的專案上右擊滑鼠,在彈出來的列表中點選”Export“選項。 2.在彈出來的”Export“視窗中,選擇匯出的目標,這裡選擇Java

註釋使用javadoc工具生成自己的api幫助

在java開發中定義類、方法時可以新增文件註釋,用 javadoc 工具來生成自己的 API 文件。 文件註釋以斜線後緊跟兩個星號(/**)開始,以星號後緊跟一個斜線(*/)結束 下面是測試類: aTest類。包名是cock packa

專案打包成jar與生成對應的api幫助(也就是註解)

玩eclipse怎麼能不知道將工程打成jar包在生成咱們平常看見的api幫助文件也就是"註解"呢,下面就來告訴大家怎麼 在說正文之前先說點注意點: javadoc的標準格式註解 程式碼註釋規範才能生成較好的api樣板: @author meng(作者) @param

Spring專案整合apidoc生成api介面

一、背景需求  JavaWeb/spring專案寫成的api介面,需要自動生成api文件,甚至需要線上測試介面。考慮實現的方案有swagger,apidoc,spring rest docs。在之後的專案都有一一嘗試,最終還是覺得apidoc的方式比較合適,雖然有一些問題(針對線上

在eclipse中檢視sources原始碼和JavaDoc幫助

今天學習Netty的過程中,從官網下載的netty裡面的內容如下: 其中jar資料夾裡面的內容如下: 可以看到每一個具體的jar包就對應有一個sources.jar包,然後所有的幫助文件在javaDoc檔案下面的jar包裡面 那怎麼檢視一個類的原始碼和幫助文件呢??? 當我們在沒有進行相應的配置前,當我

pyQt5 使用qtdesigner生成程式碼後的程式碼分析 和中文幫助程式碼不同之處

1,生成程式碼後加入幾行事件處理機制,點選按鈕 出現hello # -*- coding: utf-8 -*- # Form implementation generated from reading ui file 'untitled.ui' # # Created

生成幫助(html或chm格式)

Javadoc轉換chm幫助文件的四種方法總結 V1.0 目錄 李順利 [2010年1月6日] 關鍵詞 Javadoc chm 轉換 jd2chm javadoc2chm javadoc2help Javadoc2c

webAPI 自動生成幫助

之前在專案中有用到webapi對外提供介面,發現在專案中有根據webapi的方法和註釋自動生成幫助文件,還可以測試webapi方法,功能很是強大,現拿出來與大家分享一下。 先看一下生成的webapi文件。 1、下圖展示的是生成幫助文件首頁面,其中Values是cont

C#製作原始碼的幫助 chm幫助 C#類庫幫助生成

我們自己會寫一個核心類庫,提供給他人使用,如果沒有幫助文件,是無法告訴別人如何使用你的類庫的,即便是你有很好的註釋,用以下工具就可以生成 .chm的幫助文件了。 1、下載Sandcastle Help File Builder: 2、下載sandcastle: 1、

JDK8幫助生成-筆記

JDK8 出來了,以前習慣了使用.CHM檔案來檢視API,現在想也這樣,這裡自己製作了一下,記錄一下。 1.需要的工具: ①JD2CHM;②API文件③HTMLlHelper 遇到的問題主要是不知道去哪裡下載JAVA8的API,看了論壇上的一個帖子,幫助比較大。 感謝8

java生成zip壓縮,解壓縮

fileinput 重復 temp parent mp4 define blog exc java 1.生成zip public static void main(String[] args) { try { // testZip("

java直接生成zip壓縮精簡代碼(跳過txt

txt文件 pan cnblogs ace ipo cname exception pre ram /** * @param args */ public static void main(String[] args) throws Excep

將VS生成的msi和exe及環境集合為一個exe

exit winrar img 文件 isset rip 技術分享 nbsp 如何使用 WinRAR這個軟件之前就說很強大,今天才知道原來解壓軟件不僅僅能解壓,還能生成一個直解壓的文件exe,但是需要我們寫一個簡單的vbs或者bat文件調用cmd來運行我們的msi文件。 v

ROS知識(16)----如何編譯時自動鏈接同一個工作空間的其他包的頭(包含message,srv,action自動生成的頭

logs package fin 空間 依賴庫 osc div build 知識 catkin_make編譯時,往往需要自動鏈接同一個工作空間的其他包的頭文件。否則會出現類似如下的錯誤: /home/xx/xx_ws/srcA_package/src/db.hpp:13:

SAP 官網中文幫助&BP中文資料匯總

target oba rac pro 資料 packages spa app soft 系統 描述 版本 連接 SAP ME 制造執行 SAP Manufacturing Execution (SAP ME) 15.0 點擊我 SAP ECC