Java中使用注释

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

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

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

运行结果: Hello Imooc!

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

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

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

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

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

@version 标明该类模块的版本

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

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

@return 对方法返回值的说明

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

摘自:慕课网

原文地址:https://www.cnblogs.com/hkgov/p/9402380.html

时间: 2024-10-13 08:39:45

Java中使用注释的相关文章

Java中的注释和嵌入式文档

摘自Think in java 前面看到一位同事写的android程序,注释如同android源码一样,再看看自己写的,自己都都不懂的注释.所以抽空看了Think in java里面注释和嵌入式文档的章节,并做一个简单的总结备忘. Java中的注释分为两种,// /* */ 嵌入式文档使用了一种特殊的注释语法,通过javadoc工具(javadoc工具为jdk安装的一部分)生成HTML文档,可以使用web浏览器来查看. 语法: 所有的javadoc命令都只在/** 后的注释中才会生效. 嵌入式文

Java中的注释

Java 中的注释 关于// TODO // TODO Auto-generated method stub 是我们写类或继承接口自动生成的提示,可以留也可以不用,不过可以提示阅读者这段代码是自动生成的 根据下面途径找到Method body window Preferences Java Code Style Code Templates Code Method Body 选择edit或者双击文本区进行编辑,删去默认的内容即可 关于@Override 的作用 可以说@Override是伪代码,

慕课网-安卓工程师初养成-2-12 如何在Java中使用注释

来源:http://www.imooc.com/code/1274 在编写程序时,经常需要添加一些注释,用以描述某段代码的作用. 一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上.因此,注释是程序源代码的重要组成部分,一定要加以重视哦! Java 中注释有三种类型:单行注释.多行注释.文档注释 运行结果: 看:被注释的代码块在程序运行时是不会被执行的~~ 我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档. 打开首页,查看下生成的 AP

JAVA中的注释方法

Java的三种注释方法 ①单行注释:使用 // ,其注释内容从//开始到本行结束,比较常用, 快捷键为:Ctrl + / 或者  Ctrl + Shift + C  取消注释:Ctrl + / 或者 Ctrl + Shift + C ②多行注释:配套使用 /* 和 */ ,可以将一段比较长的注释括起来,注意不能嵌套使用, 快捷键为:Ctrl  + Shift + /  取消注释:Ctrl + Shift + \ ③文档注释:这种注释方法以 /** 开始,以 */ 结束, 快捷键:Alt + Sh

Java中的注释小结

注释本身并没有什么好说的,无非就是三种注释,使用情况分别如下: 1.三种注释方式      1.单行注释(single-line)://注释内容 一次只能注释一行,一般是简单注释,用来简短描述某个变量或属性,程序块. 2.块注释(block):/*注释内容*/ 为了进行多行简单注释,一般不使用. 3.文档注释:/**注释内容 */ 可以使用多行,一般用来对类.接口.成员方法.成员变量.静态字段.静态方法.常量进行说明.Javadoc可以用它来产生代码的文档.为了可读性,可以有缩进和格式控制. 文

2-7:如何在java中使用注释

1.什么是注释? 用以描述某段代码的作用. 2.注释的三种类型: 单行注释.多行注释.文档注释.如下图所示: 3.我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档. 4.打开首页,查看下生成的 API 文档: PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息: @author 标明开发该类模块的作者 @version 标明该类模块的版本 @see 参考转向,也就是相关主题 @param 对方法中某参数的说明 @return 对方法返回

eclipse下java中注释字体太小和xml中中文字体太小问题解决方法

我们在win7下进行android应用开发,需要搭建相应的开发环境.现在普遍基本上都是eclipse+adt+sdk,在本人搭建完环境后,发现eclipse下,java中的注释和xml中的中文字体变得特别小,无法看的清楚.解决方法如下: 1.Java中字体变大方法: 打开eclipse,Window-->Preferences,如下图打开: 双击第二个红色框,如下图: 将字体改成五号即可. 2.xml中中文字体太小解决方法: 打开eclipse,Window-->Preferences--&g

Java基础---如何在Java中注释(十)

如何在Java中使用注释 在编写程序时,经常需要添加一些注释,用以描述某段代码的作用. 一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上.因此,注释是程序源代码的重要组成部分,一定要加以重视哦! Java 中注释有三种类型:单行注释.多行注释.文档注释 运行结果: 看:被注释的代码块在程序运行时是不会被执行的~~ 我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档. 打开首页,查看下生成的 API 文档 PS:使用文档注释时还可以使用

Java中生成帮助文档

如何在Java中使用注释 在编写程序时,经常需要添加一些注释,用以描述某段代码的作用. 一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上.因此,注释是程序源代码的重要组成部分,一定要加以重视哦! Java 中注释有三种类型:单行注释.多行注释.文档注释 运行结果:?Hello Imooc! 看:被注释的代码块在程序运行时是不会被执行的~~ 我们可以通过?javadoc?命令从文档注释中提取内容,生成程序的 API 帮助文档. 打开首页,查看下生成的 API 文档 PS: