javaDoc

我们知道Java中有三种注释语句:

1.//用于单行注释。
2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套。
3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句。
   javadoc工具能从java源文件中读取第三种注释,并能识别注释中用@标识的一些特殊变量(见表),制作成Html格式的类说明文档。 javadoc不但能对一个java源文件生成注释文档,而且能对目录和包生成交叉链接的html格式的类说明文档,十分方便。

注释中可以出现的关键字,以@开头:
@author        作者名
@version       版本标识
@parameter     参数名及其意义
@since         最早出现的JDK版本
@return        返回值
@throws        异常类及抛出条件
@deprecated    引起不推荐使用的警告
@see           交叉参考

这些我们可以在eclipse里面配置 在windows->preference->java->Code Style->Code Templates

编写一个JavadocDemo.java 目录为D:\playws 

在cmd 里面先找到这个java 文件 

//找到D盘

cmd->d:

//找到这个文件

cmd->cd palyws

//编译 Java文件

cmd->javac JavadocDemo.java

//运行Java文件

cmd->java JavadocDemo

//获得Javadoc 文件

cmd->javadoc JavadocDemo.java

点赞
收藏

评论区

加载中...

相关推荐

手写Java HashMap源码

HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22

java基础之 java注释

JAVA里有2中注释风格。一种以“/\”开始以“\/”结尾,另一种是以“//”起头的。被注释的内容不会被java虚拟机编译,所以这就是为什么用反编译编译源代码没有注释的原因。举个栗子packagetest;publicclassJavaDoc{/这是单行注释/

java 多行注释

publicclassSample{publicstaticvoidmain(Stringargs){//javacompilerignoresthecommentSystem.out.println("Javaprogrammer");

java入门第二章——java编程基础

习题 一、填空题(p)1.java中的程序代码都必须在一个类中定义,类使用(class)关键字来定义。(p)2.布尔常量即布尔类型的两个值,分别是(true)和(false)(p18)3.java中的注释可分为三种类型,分别是(单行注释)(多行注释)(文档注释)(p24)4.java中的变量可分为两种数

Javadoc了解

引用百度百科的说法:javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。使用方法:使用命令行在目标文件所在目录输入javadoc文件名.java。//参考

JavaSE 基础大纲

Java基础(JavaSE)1、Java基础语法;1、1注释行内注释//多行注释/\\/文档注释/\\\/javadoc生成帮助文档1、2标识符关键字1、3数据类型1、基本数