rjps.net
当前位置:首页 >> jAvA的文档注释 >>

jAvA的文档注释

java类中有/** */ 一般用来说明一个类或者一个方法的作用和/* */ 用来屏蔽一大段无效的代码,和// 用来说明这一行代码的作用,jsp中的注释<!-- --> 一般用来屏蔽不需要输出的内容或者用来注释整个代码的简单说明,一般来说,注释都是让别人更容易读懂自己代码的

如何写Java文档注释(Java Doc Comments) 本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西 本文不讨论如何使用javadoc工具自动生成文档的方法,而是主要探讨应该如何去写文档注释 业余

1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级.如果单行无法完成,则应采用块注释. 注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释

不知你的java功底如何,一般的面向对象有类和接口,但是java弄出一个叫annotation(翻译为标注)的东西,形式如想 public @interface Override { } 他可以用于记录代码的一些metadata,这些metadata可以根据保留策略甚至可以保留在运行时态,在代码运行期间可以动态过去.在java中的@其实就是这类注释,每一个注释@override, @return, @parameter等等都对应一个annotation,具有这种特殊的格式的信息保留在代码上可以用来记录文件的一些信息,在javadoc期间可获取到这些信息,帮助生产javadoc的结构.简单的说,静态注释和动态注释吧.

Java有三种注释方式: 1、 // String a = "a"; 2、 /* String b = "b"; String c = "c"; */ 3、 /** String d = "d"; String e = "e"; */ 其中1和2是一样的,但1只是注释一行;2可以注释多行 3除了可以注释多行外,并且可以用JDK中的javadoc生成文档,Java的API document就是用javadoc生成的JDK源码中的第三类注释.所以第3类注释可以称之为注释文档.希望采纳

//单行注释,注释到行尾/*单行或多行注释*//** 可以用于文档化处理的单行或多行注释*/ JDK中提供一个文档自动生成工具JAVADOC,在自定义类中public 的成员前以/** .. */注释的内容均可被自动提取到生成的说明文档中.

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

直接使用 javadoc hello.java 就会将该类里面的文档注释解析出来,生成许多文件如图片显示 不知道对你有没有帮助

保存文件的编码和你的dos编码一致.

/** 注释的内容,一般用在类定义的上面或者方法名的上面 */

yydg.net | mcrm.net | clwn.net | qwfc.net | wwfl.net | 网站首页 | 网站地图
All rights reserved Powered by www.rjps.net
copyright ©right 2010-2021。
内容来自网络,如有侵犯请联系客服。zhit325@qq.com