Javadoc命令與API
- Javadoc工具會抽取類,成員,,方法的文檔注釋生成與這個類配套的API幫助文檔
Javadoc命令和文檔注釋小公司基本不用,,但我們應(yīng)養(yǎng)成良好的編碼習(xí)慣,所以還是了解一下
文檔注釋可以寫的大致信息為:
可以使用命令行或者idea使用Javadoc工具生成API幫助文檔
使用idea生成文檔
IDE可以幫我們很快就直接生成API文檔,,但是這對我們的學(xué)習(xí)不一定是好的,,所以我們還得自己操作一遍用命令行生成文檔
最好有時間都記住,雖然平時不咋用,,但對我們理解有一定的幫助
使用命令行生成文檔
-
什么是API,?
用通俗易懂的話來說,就是一個函數(shù),,我們想拿上用,,但又不想看它的源碼,就想直接知道它的功能和使用方法,,直接拿上用,,這個函數(shù)就是API。
API在Java中就是一個類,,我們不想看這個類的代碼,,就想直接拿上用,,這個類就是API,。
Java有很多很多的功能,我們需要用到這些功能,,但是又不想自己寫,,也不想看程序員寫的源碼,所以我們之前的程序員前輩就寫了很多類(API),,供我們使用,,我們只需要在API文當(dāng)中查看他們的功能和使用方法
-
什么是API文檔?
就是解釋API的功能和使用方法,。
|