7.包机制

包机制

(文件夹功能)

1

import com.baidu.base.*;//导入包base下面所有类

JDK8的帮助文档:https://docs.oracle.com/javase/8/docs/api/

参数信息

  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况
注释和javaDoc的区别

注释和JavaDoc都是用于文档化Java代码的工具,但是它们在参数信息的描述上有一些区别。

注释是一种通用的文档化工具,在Java中通过使用“//”或“/* */”来创建。 在注释中,可以添加任何需要说明的内容,包括对参数的描述。 但是,在注释中描述参数时,通常只是提供简短的描述,而不会提供详细的参数信息。

相反,JavaDoc是一种特定于Java的文档化工具,可以通过使用特殊的注释标签来创建,如“@param”标签来描述方法的参数。 JavaDoc提供了一种规范的方式来记录Java代码元素,并且允许生成API文档以便其他开发人员使用。

因此,JavaDoc提供了更丰富、更详细的参数信息,包括参数的名称、类型、描述以及可能的异常情况等。 这使得其他开发人员可以更轻松地理解代码的功能和使用方式。

文本注释与javaDoc的区别

文本注释是Java中用于添加代码说明和注释的一种形式,而JavaDoc是Java的一种特定工具,旨在通过使用特殊标记来记录代码元素,并生成API文档。其中包括了参数信息。

虽然文本注释可以描述参数信息,但它们没有提供规范的方式来这样做。相比之下,JavaDoc提供了一种标准的方式来描述方法和字段的参数和返回值类型,以及可能的异常情况等,使得其他开发人员可以更轻松地理解代码的功能和使用方式。

因此,尽管文本注释可以包含参数信息,但在编写完整、清晰的API文档时,建议使用JavaDoc,并添加正确格式的参数信息描述。

IDEA如何生成javaDoc

在工具栏中找到 Tool,然后再子菜单中找到 Generate JavaDoc

再进行相关配置

1

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值