前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Java注释说明以及IDEA中的快捷键

Java注释说明以及IDEA中的快捷键

作者头像
栗筝i
发布2022-12-01 21:02:17
8650
发布2022-12-01 21:02:17
举报
文章被收录于专栏:迁移内容迁移内容

一、单行注释

说明:单行注释 一般注释少量的代码或者说明内容

格式://注释的内容

IDEA中的快捷键:使用Ctrl+ /, 添加行注释,再次使用,去掉行注释

二、多行注释

说明:多行注释 一般注释大量的代码或者说明内容

格式:/*注释的内容*/

IDEA中的快捷键:使用 Ctrl+Shift+ /, 添加块注释,再次使用,去掉块注释;*/

三、文档注释

说明:文档注释 一般用于对类和方法进行功能说明

格式:/**注释的内容*/

IDEA中的快捷键:IDEA中文档注释快捷键 : 输入/** ,点击“Enter”,自动根据参数和返回值生成注释模板

1、类、接口上常用的标注
代码语言:javascript
复制
    /** 类、接口上常用的标注
     *  @author     lizhengi        #此部分代码开发者的信息、联系方式
     *  @version    1.0             #版本
     *  @see        conf.DbConfig   #另请参阅,链接到其它类|接口的文档
     *  @deprecated                 #不推荐使用
     * */
2、方法上常用的标注
代码语言:javascript
复制
/** 方法上常用的标注
 * @param       username 用户名      #参数含义
 * @return      成功返回1,失败返回0   #返回值说明
 * @throws      IOException         #抛出的异常
 * @exception   IOException         #也可以用此标记来说明抛出的异常
 * @see         conf.DbConfig       #另请参阅,链接到其它类|接口的文档
 * @deprecated                      #不推荐使用
 */
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2022-11-07,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一、单行注释
  • 二、多行注释
  • 三、文档注释
    • 1、类、接口上常用的标注
      • 2、方法上常用的标注
      领券
      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档