idea 自动添加doc_interllij idea生成javadoc
interllij idea生成javadoc
在工具欄中找到”Tools”,然后“generate JavaDoc”，會彈出”Specify Generate JavaDoc Scope”窗口，在這個窗口里你可以選擇生成整個項目的或者某個模塊的javaDoc。
亂碼
如果注釋是中文會報以下錯誤：錯誤: 編碼GBK的不可映射字符。需要添加一個參數再告訴編譯器自己使用的編碼。但這段參數代碼不會寫，所以最終端google一下出來了。然后在Other command line arguments位置填寫-encoding utf-8 -charset utf-8 這段參數代碼。然后點擊OK，就能正常的生成javadoc代碼了。但是在這個過程中可能還會有一些警告，如果你的@param中的參數未標注參數說明的話，會出現警告，如果你認為這沒關系，可以忽略。
常用命名參數
@author 作者名
@date 日期
@version 版本標識
@parameter 參數及其意義
@since 最早使用該方法/類/接口的JDK版本
@return 返回值
@throws 異常類及拋出條件
@deprecated 引起不推薦使用的警告
@see reference 查看引用
@override 重寫
更多Javadoc用法可以訪問：百度百科、官方文檔。
Javadoc注釋的規范
附上Javadoc注釋的規范，這才是本文的重點，${}的是變量，IDE會自動添加，當然也可以直接改為固定文字。
注釋的規范如下：
1、文件注釋標簽：
/**
*
Title: ${file_name}
*
Description:
*
Copyright: Copyright (c) 2013
*
Company: www.izhangheng.com
*@author zhangheng
*@date ${date}
*@version 1.0
*/
2、類型注釋標簽(類的注釋)：
/**
*
Title: ${type_name}
*
Description:
*
Company: www.izhangheng.com
*@author zhangheng
*@date ${date}
*/
3、字段注釋標簽：
/** ${field}*/
4、構造函數標簽：
/**
*
Title:
*
Description:
* ${tags}
*/
5、方法標簽：
/**
*
Title: ${enclosing_method}
*
Description:
* ${tags}
*/
6、重寫方法標簽：
/* (非 Javadoc)
*
Title: ${enclosing_method}
*
Description:
* ${tags}
* ${see_to_overridden}
*/
7、代表方法標簽：
/**
* ${tags}
* ${see_to_target}
*/
8、getter方法標簽：
/**
*@return ${bare_field_name}
*/
9、setter方法標簽：
/**
*@param ${param} 要設置的 ${bare_field_name}
*/
總結
以上是生活随笔為你收集整理的idea 自动添加doc_interllij idea生成javadoc的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 小米小爱蓝牙音箱_小米小爱蓝牙音箱——值
- 下一篇： adroid 如何测试端口号_多进程启动