Computing Reviews
Today's Issue Hot Topics Search Browse Recommended My Account Log In
Review Help
Search
HotComments: how to make program comments more useful?
Tan L., Yuan D., Zhou Y.  Hot topics in operating systems (Proceedings of the 11th USENIX Workshop on Hot Topics in Operating Systems, San Diego, CA, May 7-9, 2007)1-6.2007.Type:Proceedings
Date Reviewed: Jun 6 2008

Can knowledge contained in natural language program comments be automatically exploited to detect bugs in source code? Tan et al. seek to answer this question by first constructing a program-comment analyzer, capable of detecting rules concerned with locks for protecting access to shared variables. The analyzer exploits existing natural language processing (NLP) techniques and makes use of several heuristics. Then, the authors construct a checker: a static analysis tool that takes as input the detected lock-related rules and program source code, and outputs reports of inconsistencies, such as a function being called without acquiring a lock, when the associated function comment clearly states that a lock should be acquired.

A preliminary study of Linux source code and comments results in the automatic detection of 538 lock-related rules and 12 bugs, two of which are reported as confirmed bugs.

As a short proof of concept paper, several details and analyses are frustratingly missing. All that is said about the solution to the synonym problem is the use of keyword variants; the accuracy of the analyzer and checker are left unestimated. Can existing static analysis tools for source code detect some, or all, of the 12 bugs found through program comment analysis?

Despite the paper’s shortcomings, this line of research could be extremely profitable, and lead to the full exploitation of knowledge contained in natural language program comments. As such, I strongly recommend this paper to the software maintenance community.

Reviewer:  Andy Brooks Review #: CR135684 (0905-0471)
Bookmark and Share
  Reviewer Selected
Featured Reviewer
 
 
Documentation (D.2.7 ... )
 
 
Linux (D.4.0 ... )
 
 
Testing And Debugging (D.2.5 )
 
Would you recommend this review?
yes
no
Other reviews under "Documentation": Date
Illustrating computer documentation
Horton W., John Wiley & Sons, Inc., New York, NY, 1991. Type: Book (9780471538455)
Jun 1 1992
The art of technical documentation
Haramundanis K., Digital Press, Newton, MA, 1992. Type: Book (9781555580803)
Jun 1 1992
Integrated hypertext and program understanding tools
Brown P. IBM Systems Journal 30(3): 363-392, 1991. Type: Article
Nov 1 1992
more...

E-Mail This Printer-Friendly
Send Your Comments
Contact Us
Reproduction in whole or in part without permission is prohibited.   Copyright 1999-2024 ThinkLoud®
Terms of Use
| Privacy Policy