举报投诉联系我们 手机版 热门标签 鳄鱼CMS
您的位置:鳄鱼CMS > java文档注释快捷键 Java 文档注释

java文档注释快捷键 Java 文档注释

2023-06-03 20:31 Java教程

java文档注释快捷键 Java 文档注释

java文档注释快捷键

Java文档注释是一种特殊的注释,它可以被用来生成文档。它们通常位于类、方法和变量声明之前,用来提供有关该类、方法或变量的信息。Java文档注释使用特定的格式,并且必须遵循一定的规则。

Java文档注释快捷键是一种快速创建Java文档注释的方式,它可以帮助开发人员减少在写代码时手动输入文档注释所需要的时间。使用这些快捷键,开发人员可以在几秒钟内生成标准格式的Java文档注释。

Eclipse IDE中有一个内置的快捷键来生成Java文档注释,该快捷键是“Ctrl + Shift + J”。当你在Eclipse IDE中输入此快捷键时,将会显示一个对话框,其中包含了所有你想要包含在Java文档注释中的信息。你可以选中你想要包含在Java文档注释中的信息,然后单击“OK”即可生成标准格式的Java文档注释。

NetBeans IDE也有一个内置的快速键来生成Java文件注释,该快速键是“Alt + Shift + J”。当你在NetBeans IDE中输入此快速键时,将会显示一个对话框,其中包含了所有你想要包含在Java文件注释中的信息。你可以选中你想要包含在Java文件注释中的信

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.
@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

文档注释

在开始的


javadoc输出什么

javadoc工具将你Java程序的源代码作为输入,输出一些包含你程序注释的HTML文件。

每一个类的信息将在独自的HTML文件里。javadoc也可以输出继承的树形结构和索引。

由于javadoc的实现不同,工作也可能不同,你需要检查你的Java开发系统的版本等细节,选择合适的Javadoc版本。

实例

下面是一个使用说明注释的简单实例。注意每一个注释都在它描述的项目的前面。

在经过javadoc处理之后,SquareNum类的注释将在SquareNum.html中找到。

import java.io.*;
 

public class SquareNum {
   
   public double square(double num) {
      return num * num;
   }
   
   public double getNumber() throws IOException {
      InputStreamReader isr = new InputStreamReader(System.in);
      BufferedReader inData = new BufferedReader(isr);
      String str;
      str = inData.readLine();
      return (new Double(str)).doubleValue();
   }
   
   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 SquareNum.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_13
Building tree for all the packages and classes...
Generating SquareNum.html...
SquareNum.java:39: warning - @return tag cannot be used
                      in method with void return type.
Generating package-frame.html...
Generating package-summary.html...
Generating package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning
$


阅读全文
以上是鳄鱼CMS为你收集整理的java文档注释快捷键 Java 文档注释全部内容。
声明:本站所有文章资源内容,如无特殊说明或标注,均为采集网络资源。如若本站内容侵犯了原著者的合法权益,可联系本站删除。
相关文章
© 2024 鳄鱼CMS eyucms.com 版权所有 联系我们