基于java的测试文档自动生成方案

《基于java的测试文档自动生成方案》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、基于Java的测拭文档自动生成方案郭晓云国防大学政治学院摘要：针对软件研发中单元测试文档内容多、数量大、人工编写工作量大的问题，采用Java提供的JavaDocAPT技术和FreeMarker自动化模板技术，实现了单元测试文档的自定义和自动化生成。关键词：测试文木当;JavaDoc技术;FreeMarker技术;作者简介：郭晓云（1977-）,男，硕士，研究方向:信息自动化处理。收稿日期：2017-09-19Received：2017-09-19软件文档是软件开发和使用维护过程中的重要资料，特别是测试阶段，需要编写大量的测试文档，尤其是单元测试阶段。单元测试是对软件

2、中最小可测试单元的检查和验证，对Java程序，单元一般指Java中的一个类。一个程序会有大量的类，类的每个重要方法都要测试，此外还要进行边界、数据类型等测试，需要产生大量的测试文档。这些文档如果完全手工编写，工作量巨大。JavaDoc是Sim公司提供的一个技术，它从Java程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时生成程序的开发文档。利用JavaDoc技术，K合Freemarker模板语言和Jtest自动化测试工具，可实现测试文档的自定义和自动化生成

3、，大大减少文档工作量。1测试文档自动生成相关技术1-1JavaDocJavaDoc技术是Sun提供的-•种根据特定源码注释自动生成帮助文档的技术，JavaAPI的帮助文档就是通过JavaDoc生成的。当调用JavaDoc命令时，JavaDoc会扫描每个类的源码，提取其中的特殊标签，并根据类信息，按照一定的规则，生成相应的程序文档。JavaDoc的文档注释可对类、属性、方法等进行说明，一般以块注释形式放在类和方法的前面。JavaDoc标记是插入文档注释中的特殊标记，它们用于标识代码中的特殊引用。JavaDoc标记由及其后所跟的标记类型和专用注释引用组成，支持的标记类型

4、很多。如@8111±01'标记开发该类模块的作者，@param标记对方法中某参数的说明，标记对方法返回值的说明等，更多标记及用法可参看JavaDoc的文档。在Eclipse等IDE开发环境中，可使用快捷键自动生成相应的注释标记。JavaDoc通过命令行调用，命令格式为：javadoc[options][packagenames][sourcefiles],可土成lltml格式的JavaDoc帮助文档。如果要生成其他格式的文件，需要使用Doclet扩展机制。Doclct是用Java语言编写的程序，它用docletAPI指定Javadoc工具的输出内容和格式。缺省情况下

5、，Javadoc工具使用标准doclet生成HTML形式的API文档。用户也可用自己的doclet自定义输出。测试文档的格式一般是Word文档，因此，要自动生成单元测试文档，需要使用JavaDoc的doclet技术，编写自己的Doclet程序实现。Doclet程序首先需导入com.sun.javadoc.*。程序的入口点是一个带有publicstaticbooleanstart方法的类,它将RootDoc作为参数。用-doclet

6、jar文件屮。当编译doclct和使用自定义doclet时，tools,jar必须在类路径上。运行此doclet时，需用javadoc的-doclet标记指向编译后的doclet。命令格式为javadoc-docletdoclet主类名-classpath要处理的Java文件。也可在程序的main方法中构造Javadoc参数，使用com.sun.tools,javadoc.Main,execute(docArgs)调用。DocletAPI包括憨套的对象和方法属性，主要的对象有RootDoc、PackageDoc、ClassDoc、MethodDoc、FieldDoc

7、、Tag等。RootDoc对象代表整个Java文档，PackageDoc对象封装了Java的包，ClassDoc对象封装了Java的类，MethodDoc对象封装了类的方法，FieldDoc对象封装了类的属性，Tag对象封装了Javadoc的@标记。在自定义的Doclet中，可使用这些对象获取Java文件屮的包、类等对象的各种属性及程序屮添加的各类Javadoc标签。详细的使用说明可参看DocletAPI文档。1.2FreeMarkerFreeMarker是一种广泛使用的模板引擎，可基于模板输出文木。FreeMarker提供Java库，可方便地使用Java控制。