如何在Java中使用注释

在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。

一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!

Java 中注释有三种类型:单行注释、多行注释、文档注释

运行结果: Hello Imooc!

看:被注释的代码块在程序运行时是不会被执行的~~

我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。

打开首页,查看下生成的 API 文档

PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:

@author 标明开发该类模块的作者

@version 标明该类模块的版本

@see 参考转向,也就是相关主题

@param 对方法中某参数的说明

@return 对方法返回值的说明

@exception 对方法可能抛出的异常进行说明

Java中注释的使用相关推荐

  1. java 中注释和快捷键

    添加必要的注释,对一个有责任心.有道德模范的前端必须具备的好习惯, 可以大大提高代码的可维护性.可读性. java代码注释快捷键:ctrl+shift+/ 首先熟悉一下html.css.js的注释的写 ...

  2. java中注释的嵌套,java – 使用mybatis注释获取嵌套对象

    我有这样的POJO class foo { private String id; private String attribute; private Map dataMap; } 我的数据模型是 Ta ...

  3. java 注释 代码,如何在Java中注释代码块

    Is it possible to annotate a block of code? E.g. for cycle or simply curly brackets? If so, how? Fir ...

  4. 下列哪个不是java中注释,下面那些选项是Java中的注释方式:

    [判断题]企业的资本成本可以看作是投资者所要求的必要回报. [判断题]离层延迟改正方法中的多频改正是利用多频观测值直接计算出延迟改正或组成无线电离层延迟的组合观测量,且改正效果最好. [单选题]痛风症 ...

  5. JAVA中的变量和常量

    第一节 JAVA中的关键字 java中的关键字有以下部分 第二节 认识Java中的标识符 标识符就是用于给 Java 程序中变量.类.方法等命名的符号. package com.imooc: publ ...

  6. java中常量有初始化值吗,java的变量和常量

    Java常用变量: Java标识符: 使用标识符时,需要遵守几条规则: 1.  标识符可以由字母.数字.下划线(_).美元符($)组成,但不能包罗 @.%.空格等其它特殊字符,不能以数字开头.譬如:1 ...

  7. Java中的强制类型转换

    尽管自动类型转换是很方便的,但并不能满足所有的编程需要. 例如,当程序中需要将 double 型变量的值赋给一个 int 型变量,该如何实现呢? 显然,这种转换是不会自动进行的!因为 int 型的存储 ...

  8. 3.Java中的关键字和注释

    1.Java中的注释 注释: (1)提高程序的阅读性 (2) 调试程序 分类:   (1) 单行注释 :     //注释的文字 (2)多行注释:     /*注释的文字*/ (3)文档注释:   / ...

  9. 解决eclipse中java代码注释变成乱码的问题

    Eclipse JAVA文件注释乱码将别人的项目或JAVA文件导入到自己的Eclipse中时,常常会出现JAVA文件的中文注释变成乱码的情况,主要原因就是别人的IDE编码格式和自己的Eclipse编码 ...

最新文章

  1. Netbeans使用maven下载源码
  2. java 类隔离_微服务架构中zuul的两种隔离机制实验
  3. DIV常见任务(上) - 常规任务
  4. Linux服务器出现java.net.UnknownHostException 异常处理
  5. Android Canvas 绘图
  6. mysql数据库管理文件_数据库管理中文件的使用_MySQL
  7. MyBatis框架:延迟加载策策略、一级缓存、二级缓存
  8. 利旧IBM X3650m2 安装esxi5.1提供云桌面(备忘)
  9. pytorch神经网络因素预测_实战:使用PyTorch构建神经网络进行房价预测
  10. 从零单排HBase 02:全面认识HBase架构(建议收藏)
  11. Hadoop Hive基础sql语法
  12. C语言上机复习(一)文件操作
  13. Fingerprint指纹识别学习
  14. cocos creator 横版射击游戏全民吃鸡大战 H5+安卓+IOS三端源码
  15. 深度学习:loss损失不下降
  16. Oracle卸载卸不干净,Oracle彻底删除的办法(winxp)
  17. java对接杉德支付完整代码
  18. 基于Java解惑(站长百科)阅读笔记
  19. 如何从Rstudio中导出合适的图片?
  20. BUUCTF_MISC题解

热门文章

  1. LeetCode 1025. 除数博弈(动态规划)
  2. 腾讯邮件服务器发送慢,通过腾讯邮件服务器发送HTML邮件
  3. 日期范围 java_JavaJoDA时间-实现日期范围迭代器
  4. TaskScheduler相关
  5. java 捆绑_java – 如何在jar文件中捆绑图像
  6. Redis系列教程(三):如何解决Redis缓存雪崩、缓存穿透、缓存并发等5大难题
  7. 阿里P8高级架构师教你如何通过BAT面试顺利拿到offer
  8. 论文浅尝 | 采用多层注意力机制的事件检测
  9. 网络解析(一):LeNet-5详解
  10. RabbitMQ 简介和使用