java代码注释范例

《java代码注释范例》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、JAVA代码注释范例作者:周建东  日期:2007-10-1803:31字体大小:小中大整个类文件注释示例如下:/* *@(#)Object.java    1.6103/01/23 * *Copyright2003SunMicrosystems,Inc.Allrightsreserved. *SUNPROPRIETARY/CONFIDENTIAL.Useissubjecttolicenseterms. */ packagejava.lang; 注释结构:/* *@(#){类名称}.java      

2、{创建时间} * *{某人或某公司具有完全的版权} *{使用者必须经过许可} */ packagejava.lang;  2.    具体类功能注释示例如下:/** *ClassObjectistherootoftheclasshierarchy. *EveryclasshasObjectasasuperclass.Allobjects, *includingarrays,implementthemethodsofthisclass. * *@auth

3、or unascribed *@version1.61,01/23/03 *@see    java.lang.Class *@since  JDK1.0 */publicclassObject{} 注释结构:/** *类{类名称}{此类功能描述} * *@author {作者} *@version{版本,常用时间代替} *@see    java.lang.Class *@since  JDK{jdk版本} */publicclassObject{} 3.    类变量注释示

4、例如下:/**Thevalueisusedforcharacterstorage.*/ privatecharvalue[]; 注释结构: /**{此值是用来存储/记录什么的}*/ privateStringstr; 4.    类方法注释示例如下:   /**    *Returnsanewstringthatisasubstringofthisstring.The    *substringbeginswiththecharacteratthespecifiedindexand    *extend

5、stotheendofthisstring.

    *Examples:    *

    *"unhappy".substring(2)returns"happy"    *"Harbison".substring(3)returns"bison"    *"emptiness".substring(9)returns""(anemptystring)    *

6、thebeginningindex,inclusive.    *@return    thespecifiedsubstring.    *@exception IndexOutOfBoundsException if    *            beginIndexisnegativeorlargerthanthe    *            lengthofthisStringobject.    */publicStringsubstr

7、ing(intbeginIndex){returnsubstring(beginIndex,count);} 注释结构:   /**    *{方法的功能/动作描述}    *    *@param     {引入参数名}  {引入参数说明}    *@return     {返回参数名}  {返回参数说明}    *@exception  {说明在某情况下,将发生什么异常}    */publicStringsubstring(intbeginIndex){returnsubstring(beginI

8、ndex,count);}  5.    类方法中代码块注释示例如下:/**调用持久化类，将数据保存到库**判断是添加，还是修改*/booleanifSucc=false;if(request.getParameter("YINGLI_ID")==null){      StringGUID=newRandomGUID().toString();      stressTestDataBean.setUSER_ID(Integer.toSt