Idea配置类和方法Javadoc注释

最新推荐文章于 2023-07-07 17:57:29 发布
最新推荐文章于 2023-07-07 17:57:29 发布
阅读量1.4k 收藏 1
点赞数
分类专栏： idea 文章标签： debug app java idea
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/keepfriend/article/details/110491592
版权
本文介绍了如何在IntelliJ IDEA中配置类注释模板和方法注释模板。对于类注释，详细说明了在Settings中设置File and Code Templates的过程，并提供了示例代码。对于方法注释，通过创建Live Templates来定制个性化模板，包括添加变量和应用范围，并调整Inspections设置以避免Javadoc问题。
摘要由CSDN通过智能技术生成

配置类注释:

 打开Setting，选在Editor，然后是File and Code Templates 最后分别是Files 中的Class ,Interface和Enum，点击class后，编辑右边的红色边框，里边是模板，将模板设置好，点击ok即可。

 下边是模板中的示例代码。在新建类时，会提示description需要提前输入的，然后才会有。
 

 
  1.  

  2. /**

  3. * @program: ${PROJECT_NAME}

  4. *

  5. * @description: ${description}

  6. *

  7. * @author: 作者名字

  8. *

  9. * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}

  10. **/

  11.  

下面说一下关于方法注释的配置

 1点击"File"==>"Settings"==>"Editor"==>"Live Templates",如图:</

最低0.47元/天 解锁文章
keeper42
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
IDEA添加Java类注释模版的方法
08-28
本篇文章主要介绍了IDEA添加Java类注释模版的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
自己动手写个 IDEA 高效插件：Swagger注解、JavaDoc一键生成
最新发布
java思维导图
05-16 142
全新前后端微商城项目，手把手教学！全新前后端微商城项目，手把手教学！全新前后端微商城项目，手把手教学！下面是一个普通的Request类，先简单的看一下：/** *TestRequestdesc */ @Data @Slf4j publicclassTestRequest{ privateStringname; privateIntegerage; pr...
（必看）IDEA在类上和方法上添加Javadoc文档注释，图文详解
qq_32168785的博客
11-13 6305
IDEA在类和方法上生成文档注释 idea作为越来越多程序员使用的开发工具，平时的代码注释也非常的关键，下面介绍一下类上注释和方法上注释，方便大家的开发配置，同时也为自己以后配置留一份记录（毕竟每次换环境都需要重新配置一遍） 一、在类上生成文档注释（在接口上生成同理） File–>settings–>Editor–>File and Code Templates–>Files–>Class 在模板上加入文档注释模板，使用效果如下图 ； /** *@ClassName $
Intellij IDEA设置类和方法注释（javadoc）
JayXu's Blog
10-23 4552
目录一、设置类的注释设置settings里面的File and Code Templatesclass注释模板粘贴效果二、设置方法的注释模板设置settings里面的Live Templates方法注释模板粘贴 一、设置类的注释 idea中编写java类，class上的注释需要自己手输，不太方便。最近系统崩掉重装，之前用习惯了的注释模板都不见了，索性又去整了一下，做个记录，以防今后有需要的时候可以...
[Idea 配置]类和方法 doc注释
weixin_43696476的博客
08-18 1524
1.类注释 位置：Editor(编辑器) -> File and Code Templates(文件和代码模板) 保存后，新建class文件时就会自动出现doc注释。红框圈出来的三个文件类型算是常用的类，可以在接口和枚举类上也加入doc注释。 /** * @author cnh * @date ${DATE} * @description TODO */ 2.方法注释 2.1创建模板组 位置：Editor(编辑器) -> Live Templates(实时模板) 2.2创建动态模
idea结合javadoc注释
zhufengzhuiri的博客
06-19 1万+
Editor–&gt;File and Code Templates–&gt;Files class、Interface、Enum均添加如下注释 /** * ${PROJECT_NAME} * ${DATE} ${TIME} * ${description} * * * @author lanhaifeng * @since **/ Editor–&gt;Live Templates创建...
idea 自定义 javadoc
sun_csdn_id的博客
09-14 1640
自定义idea javadoc 格式，修改idea 默认的javadoc格式
idea如何设置类头注释和方法注释
07-14
在IDEA(IntelliJ IDEA)这个强大的Java开发环境中，可以通过设置来自动化生成符合Javadoc规范的类头注释和方法注释，以便于团队协作和文档生成。 **类头注释**： 类头注释通常包含类的功能概述、作者信息、版本信息...
IDEA生成set get方法自动带注释信息
04-30
"IDEA生成set get方法自动带注释信息"这个主题涉及到的是IDEA如何帮助开发者自动生成带有注释的getter和setter方法，这是一种常见的面向对象编程中的数据访问和修改方式。 getter和setter方法在Java中被广泛用于...
easy-javadoc本项目是IntelliJ IDEA的插件
11-10
总结起来，easy-javadoc是一个专为IntelliJ IDEA设计的插件，它简化了Java开发者生成Javadoc注释的过程，提高了开发效率。通过在IDE中集成这个插件，用户可以轻松创建符合规范的API文档，有利于项目管理和团队协作。...
本项目是IntelliJ IDEA的插件，能帮助java开发者自动生成javadoc文档注释
05-21
通常，手动编写Javadoc注释可能需要开发者花费大量时间，而这个插件通过解析代码结构和内容，能够快速地生成符合Javadoc规范的注释模板。这不仅提高了工作效率，也确保了注释的规范性和一致性。 在使用Easy Javadoc...
idea自动生成javadoc注释
心寒的博客
06-27 3213
idea自动生成javadoc注释
Intellij idea:更新网上解决Wrong tag ‘Author‘ 方案
一个深技大小学生的博客
07-07 1万+
我的版本是选择Javadoc declaration problems的Option选项才有tag选项，选择Declaration has problems in Javadoc则没有tag这个选项。可能是版本问题，我发现我的版本在tag里面添加这些信息并没有起效，创建新文件时还是会报wrong，很影响代码commit（虽然可以直接commit anyway。我在网上查找解决方案时发现每个版本的叫法也都不太一样，这里建议大家也多尝试点开看看。路径都是差不多的，但是到这里的时候发现有两个，长得很像的。
idea设置Java类注释和方法注释模板（javadoc规范）
大仁哥、的博客
12-01 1万+
1、类注释模板设置 File–>settings–>Editor–>File and Code Templates–>Files 添加模板： 简版： /** * [一句话描述该类的功能] * @author : [${USER}] * @version : [v1.0] * @createTime : [${DATE} ${TIME}] */ 复杂点的： /** * @description : [一句话描述该类的功能]
javadoc注释规范
kelaocai
08-13 1010
javadoc做注释 一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行，并写入 javadoc 文档 通常这种注释的多行写法如下： /** * ......... * ......... */ javadoc -d 文档存放目录 -author -version 源文件名.java 这条命令编译...
idea配置java模板_idea 配置java class 方法注释模板
weixin_32151313的博客
02-26 212
idea 配置java class 方法注释模板路径：Preferences -> Editor -> Live Templates点击右上角的+号，然后选择Template Group，输入group的name，点ok。输入名称，这里起的名字是Java选中刚刚创建的group Java，然后再次点击右侧的+号，这次选择的是第一个Live Template。模板配置Abbreviati...
Idea自动生成类和方法Javadoc注释
热门推荐
u012149181的博客
10-15 1万+
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。 本文链接：https://blog.csdn.net/qq_36859289/article/details/81186911 前言，我现在也是刚接触idea，写下此博客为了跟大家分享一下，同时找个地方存储一下。(好记性不如烂笔头) 我的idea版本为2018.1.6 配置类注释: ...
flask ssti python2和python3 注入总结和区别
weixin_30364147的博客
01-10 190
总结一下flask ssti的注入语句 代码 import uuid from flask import Flask, request, make_response, session,render_template, url_for, redirect, render_template_string app=Flask(__name__) app.config['SECRET_KEY']=str...
idea配置类注释和方法注释
07-10
IDEA 支持使用注释来提供类和方法的说明，以便更好地理解代码。在 Java 中，可以使用 Javadoc 注释来编写类和方法的注释。 类注释通常位于类的声明之前，使用 `/** ... */` 的格式。以下是一个示例： ```java /** * 这是一个示例类，用于演示类注释的使用。 * 它包含一些属性和方法。 */ public class ExampleClass { // 类的成员变量 /** * 这是一个示例属性，用于存储数据。 */ private int exampleProperty; // 类的构造方法 /** * 这是一个示例构造方法，用于创建 ExampleClass 的实例。 * @param value 初始化属性的值 */ public ExampleClass(int value) { exampleProperty = value; } // 类的方法 /** * 这是一个示例方法，用于执行某种操作。 * @param parameter 方法的参数 * @return 方法的返回值 */ public int exampleMethod(int parameter) { // 方法的实现 return exampleProperty + parameter; } } ``` 方法注释通常位于方法的声明之前，也使用 `/** ... */` 的格式。在方法注释中，可以描述方法的功能、参数和返回值等信息。以下是一个示例： ```java /** * 这是一个示例类，用于演示方法注释的使用。 */ public class ExampleClass { // ... /** * 这是一个示例方法，用于执行某种操作。 * @param parameter1 方法的第一个参数 * @param parameter2 方法的第二个参数 * @return 方法的返回值 * @throws IllegalArgumentException 如果参数无效，则抛出此异常 */ public int exampleMethod(int parameter1, String parameter2) throws IllegalArgumentException { // 方法的实现 if (parameter1 < 0) { throw new IllegalArgumentException("参数 parameter1 必须大于等于 0"); } return parameter1 + Integer.parseInt(parameter2); } } ``` 通过使用类注释和方法注释，可以提高代码的可读性和可维护性，并且在使用 IDE 时能够更方便地查看代码的说明。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值