欢迎来到天天文库
浏览记录
ID:50452972
大小:113.36 KB
页数:6页
时间:2020-03-06
《JAVA代码注释范例.pdf》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库。
1、JAVA代码注释范例作者:周建东日期:2007-10-1803:31字体大小:小中大整个类文件注释示例如下:/**@(#)Object.java1.6103/01/23**Copyright2003SunMicrosystems,Inc.Allrightsreserved.*SUNPROPRIETARY/CONFIDENTIAL.Useissubjecttolicenseterms.*/packagejava.lang;注释结构:/**@(#){类名称}.java{创建时间}**{某人或某公司具有完全的版权}*{使用者必须经过许可}*/packagejava.lang;2.具体
2、类功能注释示例如下:/***ClassObjectistherootoftheclasshierarchy.*EveryclasshasObjectasasuperclass.Allobjects,*includingarrays,implementthemethodsofthisclass.**@authorunascribed*@version1.61,01/23/03*@seejava.lang.Class*@sinceJDK1.0*/publicclassObject{}注释结构:/***类{类名称}3、ode>{此类功能描述}**@author{作者}*@version{版本,常用时间代替}*@seejava.lang.Class*@sinceJDK{jdk版本}*/publicclassObject{}3.类变量注释示例如下:/**Thevalueisusedforcharacterstorage.*/privatecharvalue[];注释结构:/**{此值是用来存储/记录什么的}*/privateStringstr;4.类方法注释示例如下:/***Returnsanewstringthatisasubstringofthisstring.The*substringbe4、ginswiththecharacteratthespecifiedindexand*extendstotheendofthisstring.*Examples:**"unhappy".substring(2)returns"happy"*"Harbison".substring(3)returns"bison"*"emptiness".substring(9)returns""(anemptystring)***@parambeginIndexthebeginningindex,inclusive.
Object
{类名称}3、ode>{此类功能描述}**@author{作者}*@version{版本,常用时间代替}*@seejava.lang.Class*@sinceJDK{jdk版本}*/publicclassObject{}3.类变量注释示例如下:/**Thevalueisusedforcharacterstorage.*/privatecharvalue[];注释结构:/**{此值是用来存储/记录什么的}*/privateStringstr;4.类方法注释示例如下:/***Returnsanewstringthatisasubstringofthisstring.The*substringbe4、ginswiththecharacteratthespecifiedindexand*extendstotheendofthisstring.*Examples:**"unhappy".substring(2)returns"happy"*"Harbison".substring(3)returns"bison"*"emptiness".substring(9)returns""(anemptystring)***@parambeginIndexthebeginningindex,inclusive.
3、ode>{此类功能描述}**@author{作者}*@version{版本,常用时间代替}*@seejava.lang.Class*@sinceJDK{jdk版本}*/publicclassObject{}3.类变量注释示例如下:/**Thevalueisusedforcharacterstorage.*/privatecharvalue[];注释结构:/**{此值是用来存储/记录什么的}*/privateStringstr;4.类方法注释示例如下:/***Returnsanewstringthatisasubstringofthisstring.The*substringbe
4、ginswiththecharacteratthespecifiedindexand*extendstotheendofthisstring.
*Examples:*
*"unhappy".substring(2)returns"happy"*"Harbison".substring(3)returns"bison"*"emptiness".substring(9)returns""(anemptystring)*
5、*@returnthespecifiedsubstring.*@exceptionIndexOutOfBoundsExceptionif*beginIndexisnegativeorlargerthanthe*lengthofthisStringobject.*/publicStringsubstring(intbeginIndex){returnsubstring(beginIndex,count);}注释结构:/***{方法的功能/动作描述}**@param{引入参数名}{引入参数说明}*@return{返回参数名}{返回
beginIndex
String
6、参数说明}*@exception{说明在某情况下,将发生什么异常}*/publicStringsubstring(intbeginIndex){returnsubstring(beginIndex,count);}5.类方法中代码块注释示例如下:/**调用持久化类,将数据保存到库**判断是添加,还是修改*/booleanifSucc=false;if(request.getParameter("YINGLI_ID")==null){StringGUID=newRandomGUID().toString();stressTestDataBean.setUSER_ID(Intege
7、r.toString(userId));stressTestDataBean.setSIGN_ISBN((String)vSectNum.get(0));stressTestDataBean.setSHENHE_JIEGUO("0");stressTestDataBean.setGUID(GUID);stressTestDataBean.setCREATE_DATE("getdate()");stressTestDataBean.setSTATE("A");ifSucc=StressTest
此文档下载收益归作者所有