知识大全使用Javadoc标记你需要的信息

Posted 2022-07-20 知

篇首语：人生在勤，不索何获。本文由小常识网(cha138.com)小编为大家整理，主要介绍了知识大全使用Javadoc标记你需要的信息相关的知识，希望对你有一定的参考价值。

使用Javadoc标记你需要的信息 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容，让我们赶快一起来看一下吧！

　　Java本身附带了一个很有用的工具Javadoc 它能将具有文档注释的类文件从源代码转换成HTML格式　　　　Javadoc标记有两种独立（Standalone）标记和内联（Inline）标记独立标记也就是那些常见的标记如@param @return 和@throws等但还有一些不常见的包括　　　　@author:这个标记允许你说明代码作者它还能包含email地址 web站点以及其它有关作者的附加信息　　@since: 这个标记允许你指定类版本或者产品规格 Sun公司采用这种办法让用户知道JDK各个版本的特点　　@version: 这个标记允许你指定代码版本你在这里放置的版本信息会由代码资料库自动插入源代码中去例如在CVS中使用下列语法　　*@version $Id: Strings java v / / : : hen Exp $ 　　　　　　则CVS将对其进行更新在上述例子中 Strings java是文件名是源代码的CVS版本号 / / : : 是代码放到CVS上的时间 hen则是放入代码的用户名称　　　　另一种类型的标记是内联标记这种标记采用@tag的形式在JDK 中只有一种这样的标记@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 cha138/Article/program/Java/Javascript/201311/25349

知识大全 使用Javadoc标记你需要的信息

知识大全使用Javadoc标记你需要的信息