Java在线运行

版本:

所属目录
点击了解高性能代码运行API
运行结果
教程手册
代码仓库
极速运行
交互输入
极速运行模式,更高效的运行,点击编辑器上方的运行按钮即刻体验吧。
以下是用户最新保存的代码
JAVB Base64URL编码/解码示例 发布于:2023-03-23 18:11 今天吃什么呢? 发布于:2023-03-22 17:37 //快速排序的代码演示 发布于:2023-03-18 21:24 按字典排序的组合 发布于:2023-03-17 10:06 01背包暴力法,基本不可能AC,填空使用 发布于:2023-03-17 00:32 迷宫问题AC 发布于:2023-03-17 00:08 JAVA 组合+ 发布于:2023-03-16 14:51 c测试程序保存 发布于:2023-03-16 11:15 JAVA 组合模板 发布于:2023-03-16 10:42 JAVA 小组分类 发布于:2023-03-16 10:34 JAVA 搭积木 发布于:2023-03-16 09:58 JAVA 牌型组合 组合+递归 发布于:2023-03-15 18:51 java first 发布于:2023-03-15 16:36 平行四边形 发布于:2023-03-16 18:29 学习枚举类 发布于:2023-03-14 15:16 vv平台留存 getBetweenDayList 发布于:2023-03-14 11:09 热点已经退回 发布于:2023-03-13 10:09 dfs模板 发布于:2023-03-13 10:24 TreeMap与HashMap 发布于:2023-03-10 14:51 学习TreeSet 发布于:2023-03-09 15:33 对象序列化与反序列化 发布于:2023-03-09 11:01 除法运算 除余运算 发布于:2023-03-08 19:22 生成验证码程序 发布于:2023-03-07 20:42 机票代码测试 发布于:2023-03-07 20:08 JAVA C10,4 发布于:2023-03-06 23:01 JAVA BFS模版(岛屿数量) 发布于:2023-03-06 22:49 JAVA 全排列+特殊预处理 蓝桥杯(李白斗酒) 发布于:2023-03-06 22:19 学习io文件操作 发布于:2023-03-06 18:52 dfs模版 发布于:2023-03-05 23:41 Hashmap的简单使用 发布于:2023-03-05 20:15 希尔排序的演示 发布于:2023-03-06 16:37 Java Hashmap 发布于:2023-03-06 19:59 JAVA 字符串分割 发布于:2023-03-03 21:19 学习链表的底层 发布于:2023-03-03 15:59 插入排序的代码 发布于:2023-03-05 10:47 java 标准版 KMP 发布于:2023-03-03 10:42 JAVA vectoe 数据结构 发布于:2023-03-02 22:47 Java 枚举类型 发布于:2023-03-02 22:32 堆的各种基础API 发布于:2023-03-02 22:19 学习arrayList的底层 发布于:2023-03-02 16:44 获取证书至服务器 发布于:2023-03-02 14:26 学习循环语句优化 发布于:2023-03-02 10:33 JAVA全排列 发布于:2023-03-07 17:33 今有 100 根绳子,当然会有 200 个绳头。 // 如果任意取绳头两两配对,把所有绳头都打结连接起来。最后会形成若干个绳圈(不考虑是否套在一起)。 // 我们的问题是:请计算最后将形成多少个绳圈的概率最大? 发布于:2023-03-01 21:46 给别人展示的测试 发布于:2023-03-01 08:56 Integer 型 发布于:2023-02-28 22:19 猜灯谜,String末尾用length()-1来表示 发布于:2023-02-28 19:49 倒挂的招牌 发布于:2023-02-27 21:32 铣削切削参数优化 发布于:2023-02-27 21:57 选择排序的代码 发布于:2023-02-28 10:28 [更多]
显示目录

文档注释



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

文档注释


在开始的/**之后,第一行或几行是关于类、变量和方法的主要描述.

之后,你可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*).

多个相同类型的标签应该放成一组。例如,如果你有三个@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 = inData.readLine();
      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 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
$
由JSRUN为你提供的Java在线运行、在线编译工具
        JSRUN提供的Java 在线运行,Java 在线运行工具,基于linux操作系统环境提供线上编译和线上运行,具有运行快速,运行结果与常用开发、生产环境保持一致的特点。