Paper Info
Title
Tool support for executable documentation of Java class hierarchies
Abstract
While object-oriented programming offers great solutions for today's software developers, this success has created difficult problems in class documentation and testing. In Java, two tools provide assistance: Javadoc allows class interface documentation to be embedded as code comments and JUnit supports unit testing by providing assert constructs and a test framework. This paper describes JUnitDoc, an integration of Javadoc and JUnit, which provides better support for class documentation and testing. With JUnitDoc, test cases are embedded in Javadoc comments and used as both examples for documentation and test cases for quality assurance. JUnitDoc extracts the test cases for use in HTML files serving as class documentation and in JUnit drivers for class testing. To address the difficult problem of testing inheritance hierarchies, JUnitDoc provides a novel solution in the form of a parallel test hierarchy. A small controlled experiment compares the readability of JUnitDoc documentation to formal documentation written in Object-Z. Copyright (c) 2005 John Wiley & Sons, Ltd.
Year
DOI
Venue
2005
10.1002/stvr.324
SOFTWARE TESTING VERIFICATION & RELIABILITY
Keywords
Field
DocType
documentation,extreme programming,inheritance,Java,object-oriented,specification,automated testing
Programming language,Object-oriented programming,Software engineering,Computer science,Javadoc,Unit testing,Internal documentation,Test case,Documentation,Java,Executable
Journal
Volume
Issue
ISSN
15.0
4
0960-0833
Citations 
PageRank 
References 
2
0.37
19
Authors
3
Name
Order
Citations
PageRank
Daniel Hoffman130926.89
Paul Strooper270168.70
Sarah Wilkin320.37