java如何使用命令窗口生成自定義的API官方文檔
時間:2023-09-08 來源:華清遠見
1:什么是API文檔
API的英文即Application Programming Interface首字母的縮寫。不要被這么長的單詞嚇到,直譯過來的意思就是:程序之間的接口文檔。再說簡單一點類似我們上學期間的字典,想學習java功能我們就需要學會查字典[API]。
2:自定義API文檔
想要自定義API文檔,就需要先了解注解
2.1 注解
概念:說明程序的。給計算機看的注釋:用文字描述程序的。給程序員看的
定義:注解(Annotation),也叫元數據。一種代碼級別的說明。它是JDK1.5及以后版本引入的一個特性,與類、接口、枚舉是在同一個層次。它可以聲明在包、類、字段、方法、局部變量、方法參數等的前面【框架中就會使用】,用來對這些元素進行說明,注釋簡單的說:注解就是一個給計算機看的說明【注釋】
概念描述:
JDK1.5之后的新特性
說明程序的
使用注解:@注解名稱
作用分類
①編寫文檔:通過代碼里標識的注解生成文檔【生成文檔doc文檔】
②代碼分析:通過代碼里標識的注解對代碼進行分析【使用反射】
③編譯檢查:通過代碼里標識的注解讓編譯器能夠實現基本的編譯檢查【Override】
2.2 使用注解配合命令生成api



3:注意事項
需要注意的是我們華清遠見的學生在執行命令的時候 會出現一些問題
1:敲命令的時候需要在指定文件夾里打開 命令窗口
2:需要注意字符編碼格式

