javadoc 以什么开头？计算机二级JAVA技巧：javadoc注释

大家好，今天来为大家分享javadoc 以什么开头的一些知识点，和计算机二级JAVA技巧:javadoc注释的问题解析，大家要是都明白，那么可以忽略，如果不太清楚的话可以看看本篇文章，相信很大概率可以解决您的问题，接下来我们就一起来看看吧！

java的ant是什么啊junit的用法

ANT是一个基于Java的自动化脚本引擎，脚本格式为XML。除了做Java编译相关任务外，ANT还可以通过插件实现很多应用的调用。

1)ANT的基本概念：

2)ANT的安装：解包，设置路径

3)ANT的使用：最好的学习只不过是一个简单实用的例子起步……

ANT的基本概念：Java的Makefile

当一个代码项目大了以后，每次重新编译，打包，测试等都会变得非常复杂而且重复，因此c语言中有make脚本来帮助这些工作的批量完成。在Java中应用是平台无关性的，当然不会用平台相关的make脚本来完成这些批处理任务了，ANT本身就是这样一个流程脚本引擎，用于自动化调用程序完成项目的编译，打包，测试等。除了基于JAVA是平台无关的外，脚本的格式是基于XML的，比make脚本来说还要好维护一些。

每个ant脚本（缺省叫build.xml）中设置了一系列任务(target)：比如对于一个一般的项目可能需要有以下任务。

任务1：usage打印本脚本的帮助信息（缺省）

任务2：clean<-- init清空初始化环境

任务3：javadoc<-- build<-- init生成JAVADOC

任务4：jar<-- build<-- init生成JAR

任务5：all<-- jar+ javadoc<-- build<-- init完成以上所有任务：jar javadoc

而多个任务之间往往又包含了一定了依赖关系：比如把整个应用打包任务(jar)的这个依赖于编译任务(build)，而编译任务又依赖于整个环境初始化任务(init)等。

注：我看到很多项目的ant脚本中的命名基本上都是一致的，比如：编译一般叫build或者compile；打包一般叫jar或war；生成文档一般命名为javadoc或javadocs；执行全部任务all。在每个任务的中，ANT会根据配置调用一些外部应用并配以相应参数执行。虽然ANT可调用的外部应用种类非常丰富，但其实最常用的就2，3个：比如javac javadoc jar等。

最好的学习过程就是看懂那些open source项目中的build.xml脚本，然后根据自己的需要简化成一个更简单的，ANT和APACHE上很多非常工程派的项目：简单易用，而且适应性非常强，因为这些项目的建立往往来源于开发人员日常最直接的需求。

计算机二级JAVA技巧:javadoc注释

对于软件工程来说代码的编写并不是重要的事情。文档编写的重要性不亚于程序代码本身。如果代码与文档是分离的，那么在每次修改代码时，都需要修改相应的文档就会是一件相当麻烦的事情。所以我们通过javadoc将代码同文档“连接”起来。

Javadoc是什么？

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。

Javadoc输出的是一些HTML文件，我们可以通过WEB浏览器来查看它。

Javadoc的语法：

所有Javadoc都只能源于/**开始和*/结束。使用javadoc有二种方式，一种是嵌入HTML另一种是使用文档标签。所谓文档标签就是一些以“@”开头的命令，且“@”要置于注释行的最前面。而“行内文档标签”则可以出现在Javadoc注释中的任何地方，它们也是以“@”字符开头，但要括在共括号内。

Javadoc只能为public或者protected成员进行文档注释。private和包内访问的成员的注释会被忽略掉。这样做是有道理的，因为只有public和protected成员才能在文件之外被使用，这也体现了封装性的优点。

嵌入HTML:

Javadoc将HTML代码嵌入到所生成的HTML文件中。这样能充分利用HTML的功能。比如：

/**

*

*this is my test program;

*

*/

但一般我们不要在HTML里使用标题，如

一些有用的标签：

1)@see:引用其它类的文档，相当于超链接，Javadoc会在其生成的HTML文件中，将@see标签链到其他的文档

@see classname

这样在生成的文档中会出现"See Also"的超链蛸。但是Javadoc不去检查你的超链接是否有效。

2){@link package.class#member label}

与@See的功能一样，只是用label作主超链接，而不是用"see also"

3){@docRoot}：标签产生到文档根目录的相对路径，用于文档树页面的显式超链接

4){@inheritDoc}:标签从当前这个类的最直接的基类中继承相关文档到当前的文档注释中。

5)@version：使用方法为@version 2.2.1.2...

2.2.1.2...是我们作的版本说明信息

6)@author:使用方法为@author PowerFedora powpro@hotmail.com

也就是说我们可以在@author后加上作者名字，email等联系方式

7)@since：这个标签允许你指定程序最早使用的版本。比如我们看JDK Document里的每个类最后都会说明从JDK哪个版本开始启用。

8)@param：@param name用于输入客户的姓名

@param后面是方法的参数，以及相应的说明

我们可以使用任意数量的此标签，每个参数都可以有这样一个标签

9)@return this is description

@return后面是描述返回值的含义，可以延续几行。

10)@throws fully-qualified-class-name description

fully-qualified-class-name为异常类的完整名字，而description告诉你为什么此异常会在方法中调用出现。

11)@deprecated:用于指出一些旧特性已由改进的新特性所取代，建议用户不要再使用旧特性。

接下来我们用一个代码将上述所有的标签都使用起来，看一下效果：

//: test Javadoc,JavaCode.java

import java.util.*;

/**这是一个为了测试Javadoc而专门写的类

*功能是打印字符串

*@author PowerFedora

*@author powpro@hotmail.com

*@version 1.0

*/

public class JavaCode{

/**这里的main函数，作为java程序的入口

*@param参数为一个String对象数组

*@return没有返回值的内容

*@exception exceptions没有异常被抛出

*/

public static void main(String[] args){

String a="中华人民共和国";

System.out.print(a);

}

}///:~值得一题的是，如果你使用eclipse的话，完全不需要背这些标签。当我们在需要注释的地方打上/**之后，再打@符号eclipse会自动显示所支持的标签供我们选择。

同样在生成HTML文档时我们也可以利用eclipse的export功能直接导出，否则用javadoc手工来生成的话是件相当痛苦的事情。

以下列出来javadoc支持的参数：

-author

-bootclasspath

-bottom

-breakiterator

-charset

-classpath

-d

-docencoding

-docfilessubdirs

-doclet

-docletpath

-doctitle

-encoding

-exclude

-excludedocfilessubdir

-extdirs

-footer

-group

-header

-help

-helpfile

-J

-keywords

-link

-linkoffline

-linksource

-locale

-nocomment

-nodeprecated

-nodeprecatedlist

-nohelp

-noindex

-nonavbar

-noqualifier

-nosince

-notimestamp

-notree

-overview

-package

-private

-protected

-public

-quiet

-serialwarn

-source

-sourcepath

-splitindex

-stylesheetfile

-subpackages

-tag

-taglet

-tagletpath

-title

-use

-verbose

-version

-windowtitle

Java中的 /**...*/ 什么作用,怎么用

注释有三种，单行注释//，段落注释/**/，和文档注释/***/

前两个是方便程序理解的，后一个也是

第一个：这最后这一个（/***/），有很大作用，用它写的注释，可以用java中Doc命令提取出来，生成一个专门的文档。这样，一些类啊、方法啊，都可以用这个写，写得时候，用你所问的这个注释，然后程序写好了，用doc命令吧所有的注释提取出来，不就减少了后期程序说明性文字的书写了吗？

第二个：用了这个注释（/***/），那么，当你在别的类中调用了用这个注释过得类方法的同时，你将鼠标移到这个方法上，他会显示这个方法的用途。而这个用途就是注释（/***/）中所写的。完全可以方便你知道这个方法的用途，而前两个注释是达不到的

你可以编写程序测试它第二个用途

OK，本文到此结束，希望对大家有所帮助。