您的位置:

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 copy

span style="font-size:18px;"*/

/**javadoc注释的内容

*/

public class Hello{

/**属性上的注释*/

public String name;

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

*@param args 用户输入参数

*/

public static void main(String[] args){

System.out.println("Hello World!");

f1();

}

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

public static void f1(){

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

}

}/span

[java] view plain copy

span style="font-size:18px;"import java.io.IOException;

/**javadoc注释内容

*@since 1.0

*@version 1.1

*@author Blue Jey

*br链接到另一个文档{@link Hello},就这些

*see Hello

*/

public class HelloWorld{

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

public String name;

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

*@param args 用户输入的参数,是数组

*@throws IOException main方法io异常

*/

public static void main(String args[]) throws IOException{

System.out.println("hello World!");

f1();

f2(1);

}

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

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

*/

public static void f1(){

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

}

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

*@return 返回是否OK

*@param i 输入参数i

*@see Hello

*@throws IOException io异常

*/

public static String f2(int i)throws IOException{

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

return "OK";

}

} /span

注意:

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

javadoc -version -author -d doc *.java

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

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

Java中三种类型的注释:

单行注释:// 注释内容

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

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

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

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

扩展资料:

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

参考资料来源:百度百科-java注释

请列出java中的注释

在Java里面主要有三种注释:行注释、段落注释、文档注释

1)行注释:行注释也成为单行注释,行注释使用 “//注释文字”的格式来对某一行的代码进行注释或者加以说明

2)段注释:段注释也成为多行注释,通常是当说明文字比较长的时候的注释方法

3)文档注释:文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javadoc直接生成相关文档,文档注释的基本格式为“/**...*/”,不仅仅如此,文档注释本身还存在语法

简述JAVA程序中注释的作用及类型。

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

1, // 注释一行  

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

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

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

Java:

Java是一门面向对象编程语言,不仅吸收了C++语言的各种优点,还摒弃了C++里难以理解的多继承、指针等概念,因此Java语言具有功能强大和简单易用两个特征。Java语言作为静态面向对象编程语言的代表,极好地实现了面向对象理论,允许程序员以优雅的思维方式进行复杂的编程 。

Java具有简单性、面向对象、分布式、健壮性、安全性、平台独立与可移植性、多线程、动态性等特点 。Java可以编写桌面应用程序、Web应用程序、分布式系统和嵌入式系统应用程序等。

Java注释有几种类型

三种类型:

1、单选注释:符号是://

2、块注释: 符号是: /* */ 可以跨多行

3、javadoc注释: 符号是: /** */ 可以跨多行, 生成javadoc时,这样的注释会被生成标准的javaapi注释。