API documentation from source code comments

Subscribe (Full Service)


	Search: The ACM Digital Library The Guide

	Feedback

API documentation from source code comments: a case study of Javadoc

Full text

Pdf (866 KB)

Source

ACM Special Interest Group for Design of Communication archive
Proceedings of the 17th annual international conference on Computer documentation table of contents

New Orleans, Louisiana, United States

Pages: 147 - 153

Year of Publication: 1999

ISBN:1-58113-072-4

Author

Douglas Kramer

Sun Microsystems, Inc., Palo Alto, CA

Sponsor

SIGDOC: ACM Special Interest Group for Design of Communications

Publisher

ACM New York, NY, USA

Bibliometrics

Downloads (6 Weeks): 5, Downloads (12 Months): 52, Citation Count: 12

Additional Information:

abstract references cited by index terms collaborative colleagues

Tools and Actions:	Request Permissions Review this Article Save this Article to a Binder Display Formats: BibTeX EndNote ACM Ref

DOI Bookmark:	Use this link to bookmark this Article: http://doi.acm.org/10.1145/318372.318577 What is a DOI?

ABSTRACT

This paper describes in a general way the process we went through to determine the goals, principles, audience, content and style for writing comments in source code for the Java platform at the Java Software division of Sun Microsystems. This includes how the documentation comments evolved to become the home of the Java platform API specification, and the guidelines we developed to make it practical for this document to reside in the same files as the source code.

REFERENCES

Note: OCR errors may be found in this Reference List extracted from the full text article. ACM has opted to expose the complete List rather than only correct and linked references.

Friendly, L. The Design of Distributed Hyperlinked Programming Documentation, 1995, Presented at the International Workshop on Hypermedia Design 95. httpYjavasun.com/dccs/javadoc-paper-html

CITED BY 13

	John W. Stamey, Jr. , Bryan T. Saunders, Documenting aspect-oriented PHP (AOPHP), Proceedings of the 24th annual conference on Design of communication, October 18-20, 2006, Myrtle Beach, SC, USA
	Jeffrey Stylos , Brad A. Myers , Zizhuang Yang, Jadeite: improving API documentation using usage information, Proceedings of the 27th international conference extended abstracts on Human factors in computing systems, April 04-09, 2009, Boston, MA, USA
	Robert Pierce, Leveraging technology affinity: applying a common set of tools and practices to information development, Proceedings of the 23rd annual international conference on Design of communication: documenting & designing for pervasive information, September 21-23, 2005, Coventry, United Kingdom
	Erik Berglund, Writing for adaptable documentation, Proceedings of IEEE professional communication society international professional communication conference and Proceedings of the 18th annual ACM international conference on Computer documentation: technology & teamwork, September 24-27, 2000, Cambridge, Massachusetts
	KwangChun Lee , Dan Hyung Lee, An online help framework for web applications, Proceedings of the 25th annual ACM international conference on Design of communication, October 22-24, 2007, El Paso, Texas, USA
	Henrik Eriksson , Erik Berglund , Peter Nevalainen, Using knowledge engineering support for a Java documentation viewer, Proceedings of the 14th international conference on Software engineering and knowledge engineering, July 15-19, 2002, Ischia, Italy
	Simon Frankau , Diomidis Spinellis , Nick Nassuphis , Christoph Burgard, Commercial uses: Going functional on exotic trades, Journal of Functional Programming, v.19 n.1, p.27-45, January 2009
	Thomas Vestdam , Kurt Nørmark, Maintaining program understanding: issues, tools, and future directions, Nordic Journal of Computing, v.11 n.3, p.303-320, September 2004
	Ademar Aguiar , Gabriel David, WikiWiki weaving heterogeneous software artifacts, Proceedings of the 2005 international symposium on Wikis, p.67-74, October 16-18, 2005, San Diego, California
	Raymond P.L. Buse , Westley R. Weimer, Automatic documentation inference for exceptions, Proceedings of the 2008 international symposium on Software testing and analysis, July 20-24, 2008, Seattle, WA, USA
	Erik Berglund, Designing electronic reference documentation for software component libraries, Journal of Systems and Software, v.68 n.1, p.65-75, 15 October 2003
	Mazlita Mat-Hassan , Mark Levene, Associating search and navigation behavior through log analysis: Research Articles, Journal of the American Society for Information Science and Technology, v.56 n.9, p.913-934, July 2005
	Jie-Cherng Chen , Sun-Jen Huang, An empirical analysis of the impact of software development problem factors on software maintainability, Journal of Systems and Software, v.82 n.6, p.981-992, June, 2009