当前位置:首页 » 编程语言 » 注释java

注释java

发布时间: 2022-08-07 13:42:21

java中的注释可分为三种类型

Java中三种类型的注释:

单行注释:// 注释内容

多行注释:/*... 注释内容....*/

文本注释:/**.. 注释内容....*/

代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以不是为写注释而写注释。

备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或VO对象的getter、setter方法不需加注释。

(1)注释java扩展阅读:

类(模块)注释采用 /** …… */,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。

❷ JAVA程序中注释的作用及类型分别是什么

对于Java注释我们主要了解三种:

1,// 注释一行

2,/* ...... */ 注释若干行

3,/**……*/文档注释 /** ...... */ 注释若干行,并写入 javadoc文档

java图标通常这种注释的多行写法如下: /** * ......... * ......... */

❸ java中什么是注释

注释就是,相当于解释说明。有些项目太大了,就算是自己写的代码,时间长了也不知道是什么意思。此时就需要注释,方便查找。单行注释 // 。多行注释用/* */

❹ java 中的几种注释方式

我看动力节点的java基础大全301集教中的三种注释方法:

1、单行注释 //注释的内容

2、多行注释/*......*/

3、/**......*/,这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记:

特别声明:

(1)javadoc针对public类生成注释文档

(2)javadoc只能在public、protected修饰的方法或者属性之上

(3)javadoc注释的格式化:前导*号和HTML标签

(4)javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注释的应用:

(1)首先编写.java文件

(2)在命令行中执行以下dos命令:

javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档

//javadoc标记:是@开头的,对javadoc而言,特殊的标记。

(3)在当前目录下就会产生doc文件夹,里面有一系列的.html文件

附上代码:

[java]view plain

  • <spanstyle="font-size:18px;">*/

  • /**javadoc注释的内容

  • */

  • publicclassHello{

  • /**属性上的注释*/

  • publicStringname;

  • /**这是main方法,是程序的入口

  • *@paramargs用户输入参数

  • */

  • publicstaticvoidmain(String[]args){

  • System.out.println("HelloWorld!");

  • f1();

  • }

  • /**这是第1个方法,其作用是...*/

  • publicstaticvoidf1(){

  • System.out.println("f1()!");

  • }

  • }</span>

  • [java]view plain

  • <spanstyle="font-size:18px;">importjava.io.IOException;

  • /**javadoc注释内容

  • *@since1.0

  • *@version1.1

  • *@authorBlueJey

  • *<br>链接到另一个文档{@linkHello},就这些

  • *seeHello

  • */

  • publicclassHelloWorld{

  • /**非public,protected属性上的注释不生成*/

  • publicStringname;

  • /**这是main方法,是程序的入口

  • *@paramargs用户输入的参数,是数组

  • *@throwsIOExceptionmain方法io异常

  • */

  • publicstaticvoidmain(Stringargs[])throwsIOException{

  • System.out.println("helloWorld!");

  • f1();

  • f2(1);

  • }

  • /**这是第一个方法,其作用是....

  • *@deprecated从版本1.2开始,不再建议使用此方法

  • */

  • publicstaticvoidf1(){

  • System.out.println("fl()!");

  • }

  • /**这是第二个方法,其作用是....

  • *@return返回是否OK

  • *@parami输入参数i

  • *@seeHello

  • *@throwsIOExceptionio异常

  • */

  • publicstaticStringf2(inti)throwsIOException{

  • System.out.println("f1()!");

  • return"OK";

  • }

  • }</span>

  • 注意:

    如果源文件中有用到@version,@author标记,则在执行javadoc命令时,要加-version-author

    javadoc-version-author-ddoc*.java

    (其中用-version用于提取源文件中的版本信息-author用于提取源文件中的作者信息)

❺ Java注释有几种类型

三种类型:
1、单选注释:符号是://
2、块注释: 符号是: /* */ 可以跨多行
3、javadoc注释: 符号是: /** */ 可以跨多行, 生成javadoc时,这样的注释会被生成标准的javaapi注释。

❻ java怎么注释

//单行注释
/** */多行注释

❼ java 文档注释是注释什么的,不是有多行注释了吗

1、【文档注释】是写在类或者方法的上面的。

文档注释可以用eclipse导出chm格式的帮助文档,拿给其他人用时,方便他人理解。文档注释被调用的方法,当鼠标移到上面时提醒注释内容。

使用文档注释时,需要在开始的/**之后,第一行或几行是关于类、变量和方法的主要描述。

之后,可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

2、【多行注释】注释的也是方法或类,言下之意就是一次性的将程序中的多行代码注释掉,但多行注释的内容不能用于生成一个开发者文档。

3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档,而文档注释 的内容可以生产一个开发者文档。

(7)注释java扩展阅读

java常用的文档注释标签

1、@author:标识一个类的作者

实例:@author description

2、@deprecated:指名一个过期的类或成员

实例:@deprecated description

3、@exception:标志一个类抛出的异常

实例:@exception exception-name explanation

4、{@inheritDoc}:从直接父类继承的注释

实例:Inherits a comment from the immediate surperclass.

5、{@link}:插入一个到另一个主题的链接

实例:{@link name text}

6、{@linkplain}:插入一个到另一个主题的链接,但是该链接显示纯文本字体

实例:Inserts an in-line link to another topic.

7、@param:说明一个方法的参数

实例:@param parameter-name explanation

8、@return:说明返回值类型

实例:@return explanation

9、@see:指定一个到另一个主题的链接

实例:@see anchor

10、@serial:说明一个序列化属性

实例:@serial description

❽ 什么是注释如何在Java程序中加入注释

试想一下,一个没有一句注释的程序源码,怎么读,一个程序要上万条代码不可能全部记得住哪一块是什么用,而且一个项目也不会是一个人独自完成,那样效率太低,多人合作就要给别人说明,每一块是什么用,方便他人使用,方便自己更正,而这些说明文字就是注释,注释不会被执行,不影响运行结果。

Java中代码的注释有三种:

// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行,并写入 javadoc 文档

前两种比较容易理解,至于第三种,你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。

(8)注释java扩展阅读

注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。

❾ Java如何进行单行注释和多行注释

(1)单行注释:以“ // ”开头后面接所要加的说明的内容。如下面所示: //定义变量a int a = 10; //定义变量b int b = 20;上面的语句中,在编译的过程就会直接略过注释,只会编译 int a = 10 和 int b = 20这两句。由此可见注释只是起着说明的作用。
(2)多行注释:以“/*”开头,以“*/”结尾。 假设当你要说明你所写的代码的功能时。要说明的内容有很多。如果全部放在同一行会显得很难看。所以一般会用多行来写,如下所示// 说明//说明//说明//说明以上是用四个单行注释来注释四行说明。但如果有10行说明就要按十个“//”这显示很麻烦,所以这时就可采用多行注释。上面的可改成:/*说明说明说明说明*/也可以这样/* 说明 说明 说明 说明 */
(3)文档注释:以“/**”开头,以“*/”结尾。文档注释主要是生成文档的。

热点内容
网络访问升级 发布:2025-01-22 09:18:30 浏览:190
樱花动漫盾之勇者成名录缓存 发布:2025-01-22 09:14:11 浏览:564
图色模拟脚本是什么 发布:2025-01-22 09:09:04 浏览:164
怎么重置银行卡密码 发布:2025-01-22 09:07:18 浏览:334
哪个平台云服务器好用 发布:2025-01-22 09:07:16 浏览:476
编程猫审判 发布:2025-01-22 08:54:17 浏览:142
明日之后怎么加不同服务器好友 发布:2025-01-22 08:51:08 浏览:206
php代码格式化 发布:2025-01-22 08:50:22 浏览:180
db2plsql 发布:2025-01-22 08:19:10 浏览:779
猪猪侠脚本没反应 发布:2025-01-22 08:08:37 浏览:812