分享
 
 
 

使用Javadoc标记你需要的信息

王朝java/jsp·作者佚名  2008-05-31
窄屏简体版  字體: |||超大  

Java本身附带了一个很有用的工具Javadoc,它能将具有文档注释的类文件从源代码转换成Html格式。

Javadoc标记有两种:独立(Standalone)标记和内联(Inline)标记。独立标记也就是那些常见的标记,如@param, @return, 和@throws等。但还有一些不常见的,包括:

@author:这个标记答应你说明代码作者。它还能包含email地址、web站点以及其它有关作者的附加信息。

@since: 这个标记答应你指定类版本或者产品规格。Sun公司采用这种办法让用户知道JDK各个版本的特点。

@version: 这个标记答应你指定代码版本。你在这里放置的版本信息会由代码资料库自动插入源代码中去。例如,在CVS中,使用下列语法:

*@version $Id: Strings.java,v 1.1 2002/03/06 03:03:12 hen EXP $

则CVS将对其进行更新。在上述例子中,Strings.java是文件名,1.1是源代码的CVS版本号, 2002/03/006 03:03:12是代码放到CVS上的时间,hen则是放入代码的用户名称。

另一种类型的标记是内联标记。这种标记采用{@tag}的形式。在JDK1.2中,只有一种这样的标记{@link},它答应开发者创建超级链接从注释部分连接到其它的Javadoc页面或者本页面的其它地方。

link内联标记的通常形式是:

{@linkpackage.class#member label}

Label是位于注释中间的文本,package.class#member指向一个具体的类或者方法。 Label通常和类名或者方法名称相同。正如上述语法所显示,这个标记链接到其它类的任何成员,包括方法、属性、静态变量以及构造函数。以下是一些例子:

连接到同一类的属性,采用:

@link#KEY

以上不需要package.class,并且label名称就采用成员名称即可。

连接到同一类的方法,采用:

{@link#getComponentAt(int, int) getComponentAt}

连接到其它类,采用:

{@linkjava.util.Map Map}

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有