????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????У???????????????????
?????????????????????????????????????
??????????????????????????????????????????????????????
?????????????????????????????
????????д?????????????????????????????????
?????ó?????????
????????????????Щ??дJ(rèn)avadoc???????г?У?????????????????API???????д??????????ο?????????????????????κ?С??????????????????????????????????????????????????????
????????IntelliJIDEA??????????????“??????????????????????????????????????????????”??о??????Щ????????????????????????????????????lib?????е?log(Strings??inti)????κ???????????????????????????????????“??????????????????”??
??????????????????????????????μ?Javadoc???????????????????????????????????????????????????????????????????
????дJ(rèn)avadoc??С????
??????Javadoc????????o?????????????
????@author
????@version
????@param
????@return
????@exception/@throws
????@see
????@since
????@serial/@serialField/@serialData
????@deprecated
??????????????μ???????????????????б??????????????????????????????????????д???Javadoc???????ɡ?
???????@link??@linkplain??????Щ????
?????????Javadoc?У????????????????????????????????????????????????????????????????????????@link?????????????????
????{@linkBurgersManager}????????
????{@linkBurgersManagerburgersmanager}?????б??????
????{@link#eat(Burger??boolean)}???????е????????
????{@link#eat(Burger??boolean)eat}???????д??б???????????
????{@linkBurgersManagers#eat(Burger??boolean)}??????????е????????
????{@linkBurgersManagers#eat(Burger??boolean)burgersmanagereat}??????????б??????????????
????@link??@linkplain????????????????????????????
???????@code???????????
????????????Javadoc?з?????δ????????????????÷?????????????????????????????????????????Щ???????????????????????@code??
????{<ahref='http://www.jobbole.com/members/java12'>@code</a>
????List&lt;Burger&gt;burgers=newArrayList&lt;&gt;();
????for(intindex=0;index&lt;10;index++){
????burgers.add(newBurger(“Burger#”+index));
????}
????}
????@code????????????
???????@value????????в???????
?????????????????????????????????????????????????????????
??????????????????????????????????????????????????????????????????????????????????????
???????@value??????????????????????????????????
?????????????????????????Javadoc??????????????????????????????????????????????????
/**
*Thedefaultvalueforthisfieldis{@value}.
*????????????{@value}.
*/
publicstaticfinalStringBURGER_SHOP_NAME="Thierry'sshop";
?????????????????????????磺
/**
*Thedefaultvalueforthisfieldis{@value}whenthevalue
*of{<ahref='http://www.jobbole.com/members/57845349'>@link</a>#OWNER}is{@value#OWNER}.
*????????????{@value}??
*{<ahref='http://www.jobbole.com/members/57845349'>@link</a>#OWNER}????{@value#OWNER}.
*/
publicstaticfinalStringBURGER_SHOP_NAME=&quot;Thierry&#039;sshop&quot;;
/**
*Thedefaultownerofthisawesomeburgershop.
*??????????????????.
*/
publicstaticfinalStringOWNER=&quot;Thierry&quot;;
??????@since???????????????Ч???
??????????????????б???????????????????Ч??????á???????@since?????????????????????е?汾/????
/**
*Thisawesomeclassisfordoingawesomethings
*???????????????????Щ????????
*<ahref='http://www.jobbole.com/members/chchxinxinjun'>@since</a>burger-core-0.1
*@version0.2
*/
publicclassBurgersManager{
/**
*Allowstoeatburgers
*????????
*<ahref='http://www.jobbole.com/members/chchxinxinjun'>@since</a>burger-core-0.2
*/
publicvoideat(Burgerburger??booleanfast){
//TODO
}
}
???????????????????????????????????????????????汾??????????????????????к???????飬??Щ???????в??????????????汾?????????????????0.2?汾?????Ч???????????????????????????0.2?汾????????????????????????@since???????????μ??????????Щ??????????Ч???
????????????????????????????????????????????????????????????????????????????IDE??????IntelliJIDEA???????????“@sinceburger-core-0.2″???????????????????????????汾??????????з??????????????????????????μ??????????????????????????????????????????????????????????á?
????????????????@author
?????????????????￡??????????????????????????????????????????????????д????????????????д????δ??????????????????????????????@author???????????????????????????????????????????????????????????????????????????????????????????д???
???????????????????????????????????????????????????￡??????????д?????????????????????????????????????????????????????????????????????????????????????Щ????????????????????????????????????????????????д??????????????????á?????????????????????????????@author???????????
???????void????????@return
???????????????????????????塣???????????????????????е??????????
????/**Gettheaddress.
????*@return
????*/
????publicStringgetAddress(){/*…*/}
????????????????????????@return??“????????ж??????????”??
??????????????????????????????????????????????????????????????????????????????????д??????????汾??????????????????????????????????
/**
*Gettheaddressofthisburgershop.Theaddressisofthefollowingformat:
*{<ahref='http://www.jobbole.com/members/java12'>@code</a>addressline1
*addressline2
*zipcodecity}
*@returntheaddressofthisburgershopor{<ahref='http://www.jobbole.com/members/java12'>@code</a>null}ifnotfilled.
*/
/**
????????????????????????
*{<ahref='http://www.jobbole.com/members/java12'>@code</a>?????1
*?????2
*??????}
*@return?????????????????????????{<ahref='http://www.jobbole.com/members/java12'>@code</a>null}.
*/
?????????????????????????????????????????????????д???????????????????????????@return????????????????@return????????????????Щ????????????????
??????@param????????????
?????????????????????????i?????????岻??????????????κ???????????????????????????????????????μ????????????????????????С???????????????????????@param?????????????????壬????????????Ч???????????????У?i??????????????INFO??DEBUG????TRACE?????????????????????????????????????????????????Щ???????????0???????Щ????′?1?????@param??????????????????????
???????????
??????????????????????????????????????????????????????????JDK????Java?????????????????
????????????????????????
????javadoc{packages|source-files}[options]
??????????????????????????????????????????????????
?????????????????ЩjJavadoc???????????????
????-author:????????????????@author??
????-d:?????????????????????
????-nodeprecated:????????@deprecated????????????
????-protected:????protected??public???????
????-private:????private???????
????-public:?????public???????
??????IDE???????????????????????????????????????????????????????
?????Щ??Maven??Gradle????????????????????????????????λ??????????????????????????????????????????????????????μ??
???????
???????????????????????????????????????????д????????????????????????????????
???????????????????????д????????????????????????????????????д???????????????д???