javadoc簡單使用

1,前言
java語言中,按照一定格式生成程序的文檔的工具是javadoc 。個人理解,將.java文件裏面的java代碼轉化爲和源代碼配套的API幫助文檔。
這裏就要總結一下java中一些常見的命令:
jar —— 將許多文件組合成一個jar文件
javac —— 編譯
javadoc —— 它從程序源代碼中抽取類,方法,成員等註釋形成一個和源代碼配套的API幫助文檔。
javah —— 把java代碼聲明的JNI方法轉化爲C\C++頭文件。

2,使用javadoc生成文檔
在java文件中右鍵,點擊Terminal,輸入命令 javadoc 名字.java,回車運行。
注:這裏沒有考慮編碼格式的問題,如果有漢字可能會亂碼。
解決編碼問題:javadoc -encoding UTF-8 -charset UTF-8 文件名.java
在這裏插入圖片描述

3,查看test文件夾下的生成的api文檔
在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章