The Community for Technology Leaders
2013 IEEE Sixth International Conference on Software Testing, Verification and Validation (2012)
Montreal, Quebec Canada
Apr. 17, 2012 to Apr. 21, 2012
ISBN: 978-0-7695-4670-4
pp: 260-269
ABSTRACT
Code comments are important artifacts in software. Javadoc comments are widely used in Java for API specifications. API developers write Javadoc comments, and API users read these comments to understand the API, e.g., reading a Javadoc comment for a method instead of reading the method body. An inconsistency between the Javadoc comment and body for a method indicates either a fault in the body or, effectively, a fault in the comment that can mislead the method callers to introduce faults in their code. We present a novel approach, called @TCOMMENT, for testing Javadoc comments, specifically method properties about null values and related exceptions. Our approach consists of two components. The first component takes as input source files for a Java project and automatically analyzes the English text in Javadoc comments to infer a set of likely properties for a method in the files. The second component generates random tests for these methods, checks the inferred properties, and reports inconsistencies. We evaluated @TCOMMENT on seven open-source projects and found 29 inconsistencies between Javadoc comments and method bodies. We reported 16 of these inconsistencies, and 5 have already been confirmed and fixed by the developers.
INDEX TERMS
comment analysis, random testing, test generation
CITATION
Darko Marinov, Gary T. Leavens, Shin Hwei Tan, Lin Tan, "@tComment: Testing Javadoc Comments to Detect Comment-Code Inconsistencies", 2013 IEEE Sixth International Conference on Software Testing, Verification and Validation, vol. 00, no. , pp. 260-269, 2012, doi:10.1109/ICST.2012.106
176 ms
(Ver 3.3 (11022016))