Junit和javadoc的完美结合

简介:
实际遇到的问题:
在编写junit的测试代码的时候,需要为每个Case编写注释作者等信息。而执行结果平台也需要知道这些信息,而不是通过查看测试代码来发现这些信息,这就需要在测试执行的时候读取到javadoc的信息。本文就是针对这个问题的解决方案首先,由于JavaDoc是只能读取紧贴函数的注释,目前我们Java代码中都被@Test占据。所以我想到只能修改@Test接口
         于是将Junit中@Test接口修改如下:
public @interface Test {
   
    /**
     * Default empty exception
     */
    static class None extends Throwable {
       private static final long serialVersionUID= 1L;     
       private None() {
       }
    }
   
    /**
     * Optionally specify <code>expected</code>, a Throwable, to cause a test method to succeed iff
     * an exception of the specified class is thrown by the method.
     */
    Class<? extends Throwable> expected() default None.class;
   
    /**
     * Optionally specify <code>timeout</code> in milliseconds to cause a test method to fail if it
     * takes longer than that number of milliseconds.*/
    long timeout() default 0L;
   
    String author(); //新增
   
    String description(); //新增
}
  新增了作者和注释两个新的属性;
 应用代码(即编写测试用例的时候,在@Test中必须注明作者和描述信息属性)如下:
public class TestTag {
   
    @Test(author="elbert.chenh",description="TestCase1")
    public void TestCase1()
    {
       System.out.println("OK");
    }
}
 
测试代码如下:
public class TestTestTag {
    public static void main(String[] args) {
       TestTag tt = new TestTag();
       try {
           Annotation[] annotation = tt.getClass().getMethod("TestCase1")
                  .getAnnotations();
           for (Annotation tag : annotation) {
              System.out.println("Tag is:" + tag);
              System.out.println("tag.name()" + ((Test) tag).author());
              System.out.println("tag.age()" + ((Test) (tag)).description());
           }
       } catch (NoSuchMethodException e) {
           e.printStackTrace();
       }
    }
 
}
 

本文转自elbertchen 51CTO博客,原文链接:http://blog.51cto.com/linkyou/282595,如需转载请自行联系原作者
相关文章
|
2月前
|
Java Maven
使用javadoc生成maven项目的文档
本文介绍了如何在Maven项目中使用maven-javadoc-plugin插件来生成项目的JavaDoc文档,并展示了配置插件、编写代码、运行Maven命令以及查看生成文档的完整步骤。
84 0
使用javadoc生成maven项目的文档
|
2月前
|
Java Maven Spring
用javadoc生成springboot的文档
本文介绍了生成Spring Boot项目JavaDoc文档的步骤,包括创建项目、在pom文件中添加maven-javadoc-plugin插件配置、执行Maven命令生成文档,以及查看生成的文档结果。
28 0
用javadoc生成springboot的文档
|
2月前
|
IDE Java API
Javadoc的讲解使用
本文介绍了Javadoc工具的使用方法和常用标签,通过示例代码展示了如何为Java代码添加文档注释并使用Javadoc命令生成HTML格式的API文档。
40 0
|
7月前
|
Java API
Java包机制及JavaDoc
Java包机制及JavaDoc
|
Java
Java - 关于 javadoc 命令的教辅
Java - 关于 javadoc 命令的教辅
65 0
Java - 关于 javadoc 命令的教辅
|
Java API
JavaDoc
JavaDoc命令是用来生成自己API文档的,将写好的程序放在生成的文档中 参数信息 @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @return 返回值情况 @throws 异常抛出情况 package com.wyd.base
JavaDoc
|
Oracle Java 关系型数据库
无法使用 javadoc 等命令?
谈到 Java 就离不开 JRE(Java Runtime Environment),JDK(Java Development Kit) 中包含了 JRE 和 JVM(Java Virtual Machine),所以我们一般直接安装 JDK,安装 JDK 首先肯定是去Oracle官网下载适合自己的开发版本,然后将 JDK 安装到自定义位置。
无法使用 javadoc 等命令?
|
Java Android开发
javaDOC生成
javaDOC生成
111 0