首页 > 其他分享 >eclipse、IDEA配置文档注释

eclipse、IDEA配置文档注释

时间:2024-04-01 12:22:05浏览次数:20  
标签:配置 eclipse IDEA 注释 文档 设置 方法

Javadoc:文档注释常用参数

常见注释类型 注释含义
@author 类的作者
@version 类的版本
@param 方法的参数
@return 方法的返回类型
@exception 方法抛出的异常
@see 另外参照……
@since 从什么时候开始使用的
@date 日期
@time 时间

最常用设置对象

类型(Types)注释标签(类的注释)

方法(Methods)标签:(接口和其实现类的方法,都要加注释)

Eclipse设置步骤


在这里选择目标类型,定制自己的个性化注释即可,设置好以后选择类名、方法名、字段名加上快捷键Alt + Shift + J,即可生成个性化注释。

【效果】在设置完以后,在new对象或者调用方法时,只要将鼠标悬浮于该类或者方法名称上,就能看到文档注释的具体描述,更加方便观察其功能。

IDEA设置步骤

IDEA比较细致,但是也是比较繁琐,主要关注配置的位置,设置都是类似的。

配置类的注释

位置:File–>Settings–>Editor–>File and Code Templates–>Files

在这里配置好以后创建类的时候会直接创建注释,这里相对Eclipse要方便一些。

配置方法的注释

这个配置暂时不讲了,它的配置步骤繁琐,最根本的原因是不实用,原则上和字段的文档注释一样,使用“/** + Enter”直接自定义写注释即可。

标签:配置,eclipse,IDEA,注释,文档,设置,方法
From: https://www.cnblogs.com/gengyp/p/18108115

相关文章

  • 批量word文档内容查找替换的方法
    下载 批量文档内容查找替换软件 无需安装直接运行,按界面上操作步骤可将将指定目录下的所有Word、Txt文档内容进行文本查找替换,并把查找替换后的文档另存为到到指定目录下(原文件不会动),防泄密软件,可离线断网使用比如:我要将一堆合同word文档的内容中“销售合同”“法人代表”全......
  • 批量生成word文档的方法
    按照Word模板从Excel逐行取数据填空式批量生成Word与PDF文档下载软件:Excel批量生成word 使用介绍下载 Excel批量生成word 无需安装直接运行,按界面上简单的操作步骤选择Excel数据文件、Word模板文件,即可从Excel逐行取数据安装列名对应Word模板中的占位符名,填空式批量生成W......
  • Eclipse重命名Maven工程,经常报错
    0.问题重命名Maven工程方式如下:重命名Maven工程时,发生报错:1.解决问题大概率是,重命名后无法读取到相应工程下的pom.xml了所以我们需要实时更新Maven配置,如下配置,勾选如图选项即可:......
  • 爬虫之BeautifulSoup文档树操作
    一、遍历文档树介绍1、简介在BeautifulSoup中,遍历文档树是指访问和操作HTML或XML文档的各个部分,包括标签、字符串内容等。遍历文档树,也被称为导航文档树,是指在一个文档对象模型(DOM)中按照特定的方法和规则来遍历和浏览其中的节点。DOM是一种处理XML或HTML文档的标准编程接口,......
  • IDEA中使用maven打包且包含依赖
    具体配置这里我们说的都是非SpringBoot项目正常我们在使用maven时,是不需要将依赖也包含进去的,但是如果想jar包能直接通过java-jar来执行,那么就需要包含依赖。<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artif......
  • DOM 节点遍历:掌握遍历 XML文档结构和内容的技巧
    遍历是指通过或遍历节点树遍历节点树通常,您想要循环一个XML文档,例如:当您想要提取每个元素的值时。这被称为"遍历节点树"。下面的示例循环遍历所有<book>的子节点,并显示它们的名称和值:<!DOCTYPEhtml><html><body><pid="demo"></p><script>varx,i,xmlDoc;va......
  • 基于ssm+vue.js的酒店预约及管理系统附带文章和源代码设计说明文档ppt
    文章目录前言详细视频演示具体实现截图技术栈后端框架SpringBoot前端框架Vue持久层框架MyBaitsPlus系统测试系统测试目的系统功能测试系统测试结论为什么选择我成功案例代码参考数据库参考源码获取前言......
  • 基于ssm+vue.js的校园招聘系统附带文章和源代码设计说明文档ppt
    文章目录前言详细视频演示具体实现截图技术栈后端框架SpringBoot前端框架Vue持久层框架MyBaitsPlus系统测试系统测试目的系统功能测试系统测试结论为什么选择我成功案例代码参考数据库参考源码获取前言......
  • 基于ssm+vue.js的宠物医院管理系统附带文章和源代码设计说明文档ppt
    文章目录前言详细视频演示具体实现截图技术栈后端框架SpringBoot前端框架Vue持久层框架MyBaitsPlus系统测试系统测试目的系统功能测试系统测试结论为什么选择我成功案例代码参考数据库参考源码获取前言......
  • 基于ssm+vue.js的OA办公系统附带文章和源代码设计说明文档ppt
    文章目录前言详细视频演示具体实现截图技术栈后端框架SpringBoot前端框架Vue持久层框架MyBaitsPlus系统测试系统测试目的系统功能测试系统测试结论为什么选择我成功案例代码参考数据库参考源码获取前言......