注释中带@的内容怎么自动出来

注释中带@的内容怎么自动出来

老师好,这节课中有@author 和 @return @parm这些注释,我想了解3个信息:

1、怎么样可以像老师这样快速的敲出这些代码;

2、这些都是什么意思?

3、关于这些注释,前面的课程中有介绍吗?如果有,在哪个章节?

正在回答 回答被采纳积分+1

登陆购买课程后可参与讨论,去登陆

1回答
好帮手慕小蓝 2021-11-22 10:15:17

    同学你好,老师分别对同学的问题做回答:

    1.当使用文档注释时,Eclipse会自动生成一些注解,具体的细节如下:

        1.1当在一个类上使用文档注释时,Eclipse会自动生成@author注解;

        1.2当在一个方法上使用文档注释时,如果该方法有参数则Eclipse会自动生成@parm注解;

        1.3当在一个方法上使用文档注释时,如果该方法有返回值则Eclipse会自动生成@return注解

        1.4以上三个注解都可以在输入“/**”之后直接按下回车快速生成。

    2.这三个注解都有其特定含义,用于生成API文档时,给阅读者提供相关信息,具体细节如下:

        2.1@author注解用于说明这个类的作者信息,通常后面的内容是作者名字和邮箱;

        2.2@parm注解用于说明这个方法具有的参数,这个参数分别具有什么含义,如果该方法具有多个参数,则需要对每个参数单独使用@parm注解单独说明;

        2.3@return注解用于说明这个方法会返回什么样的数据,这个数据具有什么含义。

    3.这些主角在前面的课程中没有详细介绍,这里是首次提及。由于这些注解对代码语法没有影响,并且实际开发中不同公司会对文档注释有不同的要求,为了避免同学们先入为主的硬性记忆,我们在课程中没有详细的讲解这些注释的使用。具体规范应当参照所在公司的代码规范文档。

    祝学习愉快~


  • 提问者 ienoon #1

    看到这个回答,我太感动了!谢谢老师!另外,还想问一下,我看到很多代码上的文档注释都有@date,但之前的问答中,都告诉我没有这个类型,我使用javadoc的时候,也出了错误。

    2021-11-22 10:23:41
  • 好帮手慕小蓝 回复 提问者 ienoon #2

        同学你好,@date并不是javadoc支持的注解类型,所以直接使用javadoc命令时会出现编译错误。想要使用@date注解需要单独引入相关jar包进行支持,由于不同公司的jar包不同,老师这里就不具体举例使用哪些jar包可以支持了。

        建议同学如果只是在本机上进行学习时,不要使用@date注解,避免代码报错。如果同学进入工作环境,可以阅读公司的代码规范文档,如果文档中要求使用@date注解,则按照规范进行书写即可。

        祝学习愉快~


    2021-11-22 10:36:12
问题已解决,确定采纳
还有疑问,暂不采纳

恭喜解决一个难题,获得1积分~

来为老师/同学的回答评分吧

0 星
请稍等 ...
意见反馈 帮助中心 APP下载
官方微信

在线咨询

领取优惠

免费试听

领取大纲

扫描二维码,添加
你的专属老师