首页 Java java教程 Java基础入门随笔(9)JavaSE版——文档注释

Java基础入门随笔(9)JavaSE版——文档注释

Dec 22, 2016 pm 01:15 PM

上节中写了一些static变量以及静态的方法的定义使用以及与非静态的差别,这节补充下:

如果在一个类中所有方法都为静态的,且无成员变量,这时候需要对对应的类进行限制该类无法创建对象,具体操作如下:

PRivate ArrayTool(){}

//该类中的方法都是静态的,所以该类是不需要的创建对象的。为了保证不让其他成创建该类对象,可以将该类的构造函数私有化。

1.文档注释

利用java虚假机中的javadoc工具进行文档注释生成,利用代码中的文档注释进行生成。

注意:

    1、每个编译单元(类文件)都仅能有一个public class 
    2、public class的名称(包含大小写)必须和其类文件同名。 
    3、一个类文件(*.java)中可以不存在public class。

使用 javadoc 标记:

javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明

 以上就是Java基础入门随笔(9)JavaSE版——文档注释的内容,更多相关内容请关注PHP中文网(www.php.cn)!


本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

Video Face Swap

Video Face Swap

使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版,非常好用

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

如何用文档注释对 PHP 函数进行注释? 如何用文档注释对 PHP 函数进行注释? Apr 11, 2024 pm 04:48 PM

PHP文档注释用于注释函数,包含以下必需字段:描述、参数(@param)和返回值(@return)。可选字段包括:异常(@throws)、引入版本(@since)和用法示例(@example)。使用PHPDocumentor工具可生成HTML文档以查看注释化的函数。

PHP中的代码注释 PHP中的代码注释 May 23, 2023 am 08:27 AM

代码注释是程序员在编写代码时添加的文本提醒,以便自己和其他程序员更轻松地阅读和理解代码。在PHP中,代码注释是不可或缺的。本文将详细介绍PHP中的代码注释的类型、规范和用途。一、PHP中的代码注释类型在PHP中,有三种类型的注释:单行注释、多行注释和文档注释。单行注释单行注释以双斜线“//”开始,直到行尾结束。例如://这是一个单行注释多行注释多行注释以“

C++ 函数命名中的文档注释和命名规范的互补关系 C++ 函数命名中的文档注释和命名规范的互补关系 May 03, 2024 am 09:00 AM

C++中函数命名规范和文档注释相互补充,提升代码可读性。命名规范提供清晰且一致的函数名称,而文档注释补充了其目的、参数、返回值和前提条件等详细信息,确保代码易于理解、维护和扩展。

Java初学者:如何定义入门阶段? Java初学者:如何定义入门阶段? Feb 18, 2024 pm 06:29 PM

Java入门:学习到哪一步才算入门?Java作为一门广泛应用于软件开发领域的编程语言,具有易学、跨平台、安全性高等特点,因此备受程序员们的喜爱。许多初学者都希望能够尽快入门Java,并展开自己的编程之旅。那么,我们如何判断自己已经入门了Java,学习到了哪一步呢?首先,我们需要明确一个概念:入门并不等于精通。入门只是完成了对Java语言的初步了解和掌握,能够

学习Java技术的重要前提:理解核心概念和应用工具 学习Java技术的重要前提:理解核心概念和应用工具 Jan 13, 2024 pm 03:02 PM

学习Java技术的必备知识:掌握关键概念和开发工具,需要具体代码示例Java是一种广泛应用于软件开发领域的计算机编程语言。它的强大之处在于其跨平台特性和丰富的开发工具支持,使得Java成为了当今最受欢迎的编程语言之一。如果你想要学习Java技术,掌握一些关键概念和开发工具是必不可少的。本文将为你介绍一些必备的Java知识,并提供一些具体的代码示例来帮助你更好

JAVA核心知识的高效学习方法分享 JAVA核心知识的高效学习方法分享 Nov 08, 2023 pm 06:44 PM

JAVA是一门面向对象的编程语言,在软件开发领域有着广泛的应用。掌握并熟练运用JAVA的核心知识对程序员来说至关重要,它能够提高开发效率,让代码更加可靠和易维护。本文将分享几种高效学习JAVA核心知识的方法,并提供具体的代码示例。一、学习JAVA核心知识的基本步骤学习一个新的编程语言,首先需要掌握其基本语法和特性。对于JAVA来说,可以通过阅读相关的教程或书

PHP注释规范:如何使用文档注释编写API文档 PHP注释规范:如何使用文档注释编写API文档 Jul 30, 2023 pm 07:00 PM

PHP注释规范:如何使用文档注释编写API文档引言:在开发PHP应用程序时,编写完善的API文档对于开发团队和其他开发者来说非常重要。好的文档可以提高代码的可读性和可维护性,并促进团队合作与信息共享。本文将介绍如何使用文档注释编写PHP的API文档,并提供一些示例代码帮助读者理解如何规范地编写注释。注释规范在PHP中,我们使用注释来对代码进行说明和描述。一般

如何在项目文档和文档注释中明确最新PHP代码规范的要求和建议? 如何在项目文档和文档注释中明确最新PHP代码规范的要求和建议? Sep 05, 2023 pm 02:16 PM

如何在项目文档和文档注释中明确最新PHP代码规范的要求和建议?引言:在进行PHP项目开发过程中,遵循统一的代码规范非常重要。良好的代码规范可以提高代码的可读性和可维护性,减少编码错误,提高团队协作效率。为了确保项目代码质量,开发团队需要明确最新的PHP代码规范要求和建议。在本文中,我们将介绍如何在项目文档和文档注释中明确这些要求和建议,并通过代码示例加以说明

See all articles