javaDoc

Wesley13
• 阅读 386

我们知道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

点赞
收藏
评论区
推荐文章
Wesley13 Wesley13
2年前
java基础之 java注释
JAVA里有2中注释风格。一种以“/\”开始以“\/”结尾,另一种是以“//”起头的。被注释的内容不会被java虚拟机编译,所以这就是为什么用反编译编译源代码没有注释的原因。举个栗子packagetest;publicclassJavaDoc{/这是单行注释/
Wesley13 Wesley13
2年前
java 多行注释
publicclassSample{publicstaticvoidmain(Stringargs){//javacompilerignoresthecommentSystem.out.println("Javaprogrammer");
Wesley13 Wesley13
2年前
java入门第二章——java编程基础
习题 一、填空题(p)1.java中的程序代码都必须在一个类中定义,类使用(class)关键字来定义。(p)2.布尔常量即布尔类型的两个值,分别是(true)和(false)(p18)3.java中的注释可分为三种类型,分别是(单行注释)(多行注释)(文档注释)(p24)4.java中的变量可分为两种数
Wesley13 Wesley13
2年前
java核心技术第二篇之数据库SQL语法
查询products表记录SELECT\FROMproductsWHEREprice2000;–单行注释/\多行注释\/创建数据库CREATEDATABASEhei66\_day19\_db;hei66\_day19\_db查看数据库SHOWDATABASES;
Stella981 Stella981
2年前
Python 字符串与基本语句
Python特点python中没有变量的声明语句结束后没有分号严格要求缩进支持很长很长的大数运算(直接在Idle中输入即可)用“”来注释BIF:Bulitinfunctions(内置函数)input
Wesley13 Wesley13
2年前
Javadoc了解
引用百度百科的说法:javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。使用方法:使用命令行在目标文件所在目录输入javadoc文件名.java。//参考
Wesley13 Wesley13
2年前
JavaSE 基础大纲
Java基础(JavaSE)1、Java基础语法;1、1注释行内注释//多行注释/\\/文档注释/\\\/javadoc生成帮助文档1、2标识符关键字1、3数据类型1、基本数
Wesley13 Wesley13
2年前
C++ 注释
C注释程序的注释是解释性语句,您可以在C代码中包含注释,这将提高源代码的可读性。所有的编程语言都允许某种形式的注释。C支持单行注释和多行注释。注释中的所有字符会被C编译器忽略。1include<iostream23/runthisprogramusingthe
Wesley13 Wesley13
2年前
Java语言基础
一,注释1,分类单行,多行,文档注释2,文档注释a,生成APIb,用法:javadoc 注:ApplicationProgrammingInterfaces应用程序编程接口(其实就是说明书)3,注释是不会出现字节码文件里的二,包1,简述a,包是用来管理类的,类似文件夹管理文件b,其作用为防止命
小万哥 小万哥
5个月前
C 语言注释和变量详解
C语言中的注释C语言中可以使用注释来解释代码并使其更具可读性。它还可以在测试替代代码时防止执行。单行注释单行注释以两个斜杠(//)开头。//和行末之间的任何文本都会被编译器忽略(不会被执行)。此示例在代码行之前使用单行注释:c//这是一个注释printf(