//在Java中我們有時候會用到Java給我們提供的各種方法,例如冒泡排序,獲得字元串長度等,這些方法如果不加以說明的話,我們是很難搞明白如何用這些方法,比如方法的參數所起的作用等。。。是以開發人員會為自己寫好的類和方法寫一個幫助文檔,讓用的人看。下面是一段代碼,我會用這段代碼生成一個幫助文檔。
public class ArrayTool
{
ArrayTool(){}
public static void getMax(int[] arr){
int max=arr[0];
for (int x=1;x<arr.length ;x++ )
{
if (max>=arr[x])
{
}else
{
max=arr[x];
}
}
System.out.println(max);
}
}
将自己想要表達的意思,對代碼的解釋寫到注釋中去,其中帶@符号的單詞是一些文檔中的特殊字段,生成文檔時系統會自動識别,下面将在cmd中輸入如下語句:
然後等待檔案生成,你就會在你的Java檔案存放的目錄下看到一個叫mydoc1 的文檔,打開,如圖,
直接打開index 檔案,就可以看到你想要生成的文檔了~~
注意! 如果你想讓文檔生成到其他位置,可以這樣在cmd中寫:javadoc -df:\mydoc2 -author -version ArrayDemo.java即可