什么叫做API幫助文檔？
Application Programming Interface應(yīng)用編程適配器，語言、框架以及類庫對外提供的編碼的適配器蛤迎。
API幫助文檔有什么用？
java有自己的官方的API幫助文檔含友，就是很多官方的介紹和類替裆、方法、變量的解釋窘问。一般很系統(tǒng)辆童，涉及所有的方面，如果開發(fā)人員對正在使用的類不熟悉惠赫，想查看類里面的變量或者方法把鉴，就可以打開JavaAPI文檔進行閱讀和查看《郏可以讓開發(fā)人員迅速的得到自己想要的系統(tǒng)的方法庭砍。
為什么定義幫助文檔？
當(dāng)我們寫了一個功能給別的開發(fā)者使用的話混埠。我們定義幫助文檔就會讓別人更好的了解你寫的代碼怠缸。這樣可以幫助別人使用的我們寫的功能的時候可以快速的提升他寫代碼的能力。
怎樣定義幫助文檔钳宪？
圖1
首先我們定義一個我們需要的功能點的類揭北，我們對這個類的每一個屬性和方法寫了注釋概耻，向圖1我們對方法寫的注釋我們在調(diào)用的時候，會提示我們這個方法的作用和參數(shù)以及返回值罐呼。那我們要如何將這個類轉(zhuǎn)化為API幫助文檔呢？分為以下幾步：
第一步
1侦高、進入文件所在位置
第二步
第二步：利用javadoc 文件名或者是文件夾的名生成有關(guān)的html文件嫉柴。
第三步
這樣生成了一個HTML文件
圖二
這就是我們生成API文檔了。
