Sciweavers

CHI
2009
ACM

Jadeite: improving API documentation using usage information

14 years 11 months ago
Jadeite: improving API documentation using usage information
Jadeite is a new Javadoc-like API documentation system that takes advantage of multiple users' aggregate experience to reduce difficulties that programmers have learning new APIs. Previous studies have shown that programmers often guessed that certain classes or methods should exist, and looked for these in the API. Jadeite's "placeholders" let users add new "pretend" classes or methods that are displayed in the actual API documentation, and can be annotated with the appropriate APIs to use instead. Since studies showed that programmers had difficulty finding the right classes from long lists in documentation, Jadeite takes advantage of usage statistics to display commonly used classes more prominently. Programmers had difficulty finding the right helper objects and discovering how to instantiate objects, so Jadeite uses a large corpus of sample code to automatically identify the most common ways to construct an instance of any given class. Keywords APIs,...
Jeffrey Stylos, Brad A. Myers, Zizhuang Yang
Added 24 Nov 2009
Updated 24 Nov 2009
Type Conference
Year 2009
Where CHI
Authors Jeffrey Stylos, Brad A. Myers, Zizhuang Yang
Comments (0)