源碼注釋規(guī)范,一定要用/** 兩個*這一特殊的注釋。注釋上可以添加@author等特殊說明,下圖是部分 javadoc 標記 信息,可以根據(jù)需要選用。
1)選中項目 -> 菜單欄Project -> Generate Javadoc
2)選擇visibility, 默認是Public, 可以選擇Private; 點擊Browse...選擇輸出路徑 -> Next
3)為API文檔起個名字, 例如: Project Doc; 為了保證生成的api過程中沒有錯誤, 點擊Select All選擇所有的引用jar包(注意:如果有些jar包不在列表中, 如servlet-api.jar, 可以將這個jar包復制到項目的lib目錄下, 等生成完api文檔后, 再從項目的lib目錄下刪除掉) -> Next
4)為保證生成過程中, 編碼不統(tǒng)一導致錯誤, 這里加上一行參數(shù):
-encoding utf-8 -charset utf-8
5)Finish -> Yes To All; 如果控制臺有錯誤, 將錯誤解決掉, 警告可以忽略掉, 之后就可以到指定的路徑下查看生成的api文檔了。
本站僅提供存儲服務,所有內(nèi)容均由用戶發(fā)布,如發(fā)現(xiàn)有害或侵權內(nèi)容,請
點擊舉報。