如何注释java代码 怎样做java代码的注释

java 中的几种注释方式

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

成都创新互联公司是专业的磁县网站建设公司,磁县接单;提供成都做网站、成都网站设计、成都外贸网站建设,网页设计,网站设计,建网站,PHP网站建设等专业做网站服务;采用PHP框架,可快速的进行磁县网站开发网页制作和功能扩展;专业做搜索引擎喜爱的网站,专业的做网站团队,希望更多企业前来合作!

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用于提取源文件中的作者信息)

如何用Eclipse快速注释程序代码?

在进行程序调试时,可能需要注释掉大片的程序代码,以缩小Bug出现的范围,从而尽快锁定错误原因。那么使用Eclipse如何快速注释程序代码呢?下面就讲解3种常用方法。

法一:使用Ctrl+/快捷键

第1步:在Eclipse中拖动鼠标,选中需要注释的代码,通常为连续多行代码。

第2步:按住Ctrl+/快捷键

第3步:会发现所选代码被“//”注释掉。当调试完后,可再次按住Ctrl+/快捷键打开注释。

方法二:使用Ctrl+Shift+C快捷键

第1步:在Eclipse中拖动鼠标,选中需要注释的代码。

第2步:按住Ctrl+Shift+C快捷键

第3步:会发现所选代码被“//”注释掉。当调试完后,可再次按住Ctrl+Shift+C快捷键打开注释。

方法三:使用Ctrl+Shift+/快捷键

第1步:在Eclipse中拖动鼠标,选中需要注释的代码。

第2步:按住Ctrl+Shift+/快捷键。

第3步:会发现所选代码被“/*  */”注释掉。

第4步:当调试完后,可按住Ctrl+Shift+\快捷键打开注释。

如何写好java代码注释

写代码的时候,有时候,你需要写一些注释,把内容相互关联起来,方便自己或别人看的时候,可以直接找到你关联的代码类或者啥的。

这个时候,{@link}与@see,这2个javadoc注解就派上用场了,

不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。

@see 标签允许用户引用其他类的文档。具体使用方式如下:

@see classname

@see fully-qualified-classname

@see fully-qualified-classname#方法名称

@see fully-qualified-classname#属性名称

我在使用的时候,发现这个只能单独一行顶头写,如果不顶头写就不管用了,没了链接的效果。

但是,{@link}这个却可以随便放。

具体使用方法和上面那个@see是一样的。

实际效果,看下面的图


网页标题:如何注释java代码 怎样做java代码的注释
文章URL:http://bzwzjz.com/article/dosjpdh.html

其他资讯

Copyright © 2007-2020 广东宝晨空调科技有限公司 All Rights Reserved 粤ICP备2022107769号
友情链接: 成都企业网站建设公司 成都网站制作 营销网站建设 成都网站设计 成都网站建设公司 专业网站设计 企业网站设计 响应式网站设计 成都网站制作 广安网站设计 成都网站建设 营销型网站建设 成都企业网站设计 成都网站建设 响应式网站设计方案 企业网站建设 成都网站设计公司 高端网站设计 成都企业网站制作 营销网站建设 成都营销网站制作 企业网站制作