Java注释link_Java⽂档注释
Java只是三种注释⽅式。前两种分别是// 和/* */，第三种被称作说明注释，它以/** 开始，以 */结束。
说明注释允许你在程序中嵌⼊关于程序的信息。你可以使⽤javadoc⼯具软件来⽣成信息，并输出到HTML⽂件中。
说明注释，是你更加⽅⾯的记录你的程序的信息。
javadoc 标签
javadoc⼯具软件识别以下标签：标签描述⽰例
@author标识⼀个类的作者@author description
@deprecated指名⼀个过期的类或成员@deprecated description
{@docRoot}指明当前⽂档根⽬录的路径Directory Path
@exception标志⼀个类抛出的异常@exception exception-name explanation
{@inheritDoc}从直接⽗类继承的注释Inherits a comment from the immediate surperclass.
{@link}插⼊⼀个到另⼀个主题的链接{@link name text}
{@linkplain}插⼊⼀个到另⼀个主题的链接，但是该链接显⽰纯⽂本字体Inserts an in-line link to another topic.
java修改html文件
@param说明⼀个⽅法的参数@param parameter-name explanation
@return说明返回值类型@return explanation
@see指定⼀个到另⼀个主题的链接@see anchor
@serial说明⼀个序列化属性@serial description
@serialData说明通过writeObject( ) 和 writeExternal( )⽅法写的数据@serialData description
@serialField说明⼀个ObjectStreamField组件@serialField name type description
@since标记当引⼊⼀个特定的变化时@since release
@throws和 @exception标签⼀样.The @throws tag has the same meaning as the @exception tag.
{@value}显⽰常量的值，该常量必须是static属性。Displays the value of a constant, which must be a static field. @version指定类的版本@version info
⽂档注释
在开始的/**之后，第⼀⾏或⼏⾏是关于类、变量和⽅法的主要描述.
之后，你可以包含⼀个或多个何种各样的@标签。每⼀个@标签必须在⼀个新⾏的开始或者在⼀⾏的开始紧跟星号(*).
多个相同类型的标签应该放成⼀组。例如，如果你有三个@see标签，可以将它们⼀个接⼀个的放在⼀起。
下⾯是⼀个类的说明注释的⽰例：/*** This class draws a bar chart.
* @author Zara Ali
* @version 1.2*/
javadoc输出什么
javadoc⼯具将你Java程序的源代码作为输⼊，输出⼀些包含你程序注释的HTML⽂件。
每⼀个类的信息将在独⾃的HTML⽂件⾥。javadoc也可以输出继承的树形结构和索引。
由于javadoc的实现不同，⼯作也可能不同，你需要检查你的Java开发系统的版本等细节，选择合适的Javadoc版本。
实例
下⾯是⼀个使⽤说明注释的简单实例。注意每⼀个注释都在它描述的项⽬的前⾯。
在经过javadoc处理之后，SquareNum类的注释将在SquareNum.html中到。import java.io.*; /*** This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2*/public class SquareNum {
/**
* This method returns the square of num.
* This is a multiline description. You can use
* as many lines as you like.
* @param num The value to be squared.
* @return num squared.
*/
public double square(double num) {
return num * num;
}
/**
* This method inputs a number from the user.
* @return The value input as a double.
* @exception IOException On input error.
* @see IOException
*/
public double getNumber() throws IOException {
InputStreamReader isr = new InputStreamReader(System.in);
BufferedReader inData = new BufferedReader(isr);
String str;
str = adLine();
return (new Double(str)).doubleValue();
}
/**
* This method demonstrates square().
* @param args Unused.
* @return Nothing.
* @exception IOException On input error.
* @see IOException
*/
public static void main(String args[]) throws IOException
{
SquareNum ob = new SquareNum();
double val;
System.out.println("Enter value to be squared: ");
val = ob.getNumber();
val = ob.square(val);
System.out.println("Squared value is " + val);
}
}
如下，使⽤javadoc⼯具处理SquareNum.java⽂件：$ javadoc SquareNum.java Loading source file
Constructing
Standard Doclet version 1.5.0_13
Building tree for all the packages
Generating
SquareNum.java:39: warning - @return tag cannot be used\
in method with void return type.
Generating
Generating
Generating
Generating
Building index for all the packages
Generating
Generating
Generating
Building index for
Generating
Generating
Generating
Generating
Generating 1 warning

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。