Java 18 Snippet 标签及示例

2024 年 9 月 10 日 | 阅读 3 分钟

在 Java 18 中，为了解决 code 标签的缺点，引入了 snippet 标签。Java 18 在 Java API 文档中以新功能的形式添加了代码片段。

Javadoc 标准文档生成器包含 Java 中的 @snippet 标签，它使在 API 文档中添加源代码变得更加容易。Java 中的 Snippet 标签是方法的替代选项，这些方法易于使用，功能更强，适应性更高。

解释

Javadoc 工具将用于渲染代码主体并将其转换为 HTML 代码。此方法或技术的缺点包括不突出语法、包含 HTML 标记、不处理缩进问题等。引入 snippet 标签是为了解决 code 标签的缺点。Java 中主要有两种 Snippet：内联 (Inline) 和外部 (External)。让我们通过几个 Java 示例程序来详细了解它们。

内联 Snippets

可以使用 @snippet 标签及其最简单的语法来包含可以作为源代码或其他类型的结构化文本的文本片段。

生成的文档将以 HTML 代码的形式渲染 snippet 标签的文本。像 < 和 > 这样的特殊字符将不会被 HTML 实体转义。

文件名： InlineSnippet.java

/*
 Java program for demonstrating inline snippet in Javadoc.
 It has a method that performs addition of two integer numbers.
*/
public class InlineSnippet{
    /*
    The addition of two integer values is performed and result is returned.
	<p>Snippet:
    {@snippet InlineSnippet#AddNumbers}
    int a - the first integer parameter.
    int b - the second integer parameter.
    @return The result calculated by adding both parameters.
    */
    public int AddNumbers(int a, int b) {
        return a + b;
    }
	public static void main(String[] args)
	{
		InlineSnippet ob1 = new InlineSnippet();
		int result;
		result = ob1.AddNumbers(10,20);
		System.out.println("The Result Obtained By Addition = "+result);
	}
}

输出

The Result Obtained By Addition = 30

解释

在上面提到的 Java 示例程序中，使用内联 snippet 标签 {@InlineSnippet#AddNumbers} 来在生成的 Javadoc HTML 中包含与 AddNumbers 方法相关的代码。

外部 Snippets

并非总是推荐在 Java 中使用内联 snippet，因为它不方便。当尝试在注释中编写字符序列时，字符串变量也可能包含 */ 字符序列。

在 snippet 标签访问外部文件中的代码的情况下，可以使用外部 snippet 来解决。

示例 1

文件名： SnippetTag1.java

// Java program for demonstration of Java Snippet tags
public class SnippetTag1 {
    void display() {
        System.out.println("JAVA SNIPPET TAGS EXAMPLE PROGRAM");
    }
    public static void main(String[] args) {
        SnippetTag1 ob1 = new SnippetTag1();
        ob1.display();
    }
}

输出

JAVA SNIPPET TAGS EXAMPLE PROGRAM

示例 2

文件名： ExternalSnippet.java

// Java program for demonstration of features and functionalities of External Snippet in Javadoc
import java.util.*;
import java.io.*;
public class ExternalSnippet{
    /**
     Calculates and returns the Sqaure value of a number.
    parameter num - The number whose Sqaure value will be calculated.
    @return Returns the Sqaure value of the parameter integer value provided.
    */
    public static int sqaureValue(int num) {
		int result;
		result = num * num;
        return result;
    }
	public static void main(String[] args)
	{
		ExternalSnippet ob1 = new ExternalSnippet();
		int result; 
		int num = 10;
		result = sqaureValue(num);
		System.out.println("The Square Value of "+num+" = "+result);
	}
}

输出

The Square Value of 10 = 100

下一主题Java 对象生命周期

Java 18 Snippet 标签及示例

内联 Snippets

外部 Snippets

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Java Conversion

Java Misc

Java 18 Snippet 标签及示例

内联 Snippets

外部 Snippets

相关帖子

Java 中的最大正方形矩阵问题

Java 中的别名

Banking Application Using Multithreading in Java

Java 中使用逐词匹配查找最长公共前缀

为什么 Java 不是纯粹的面向对象语言

DoubleBuffer slice() method in Java with Examples

Java 中不使用循环打印 1 到 100

Java 规范名称

Java 中的链表实现

Java 中的 BlockingQueue

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器