"You probably should be reading this..." - Getting people to read your JavaDocs with eMoose

Uri Dekel

Eclipse IDE And Languages - Java · Poster

This talk has been accepted but has not yet been assigned a time slot.

[This is a poster to accompany an accepted talk #319] JavaDocs are often the only way in which method authors can communicate with their prospective clients and convey important usage directives, restrictions, and caveats. Unfortunately, these clients rarely have the time to search the documentation of each and every invoked method for directives hidden within the detailed narrative, and authors have no means of leading them to read their method documentations. This may lead to significant breakdowns. This poster presents eMoose, a framework that allows directives to be associated with methods, and then decorates calls to these methods to attract the reader's attention to them. It also augments the JavaDoc hover clearly identify the directives associated with the target. eMoose can also decorate calls when a directive is associated with an overriding methods in a potential dynamic type, alerting clients to potential conformance issues. Developers can associate directives by embedding them in the documentation with simple tags, or using a client-server model that allows API user communities to annotate and distribute directives for APIs without support from their vendors. eMoose also automatically decorates calls to methods with to-do comments to increase awareness of their unfinished nature. The tool is freely available from http://emoose.cs.cmu.edu.

Uri is a Ph.D. candidate of Software Engineering at Carnegie Mellon University's School of Computer Science. His research is concerned with human aspects of software development, including program understanding, collaborative work, and documentation usability. He spends too much of his research time developing software, and for the past few years has been working on the eMoose memory aid for software developers (http://emoose.cs.cmu.edu). Prior to his doctoral studies he developed software at Intel and at IBM Research. He also taught courses on software development at the Israel Institute of Technology, where he received his M.Sc. and B.Sc. degrees in Computer Science.

Gold sponsors

IBM Corporation

Windriver logo

JBoss

Sun Microsystems

SOPERA

BLU AGE

BIRT Exchange by Actuate

Silver sponsors

Innovations Software Technology

Google

Genuitec

Instantiations

itemis

EclipseSource

Innovent Solutions

SAP Business Objects

Hardware Sponsor

Cisco

Lanyard Sponsor

Intel logo



report a problem with this page