Writing for adaptable documentation
IPCC/SIGDOC '00 Proceedings of IEEE professional communication society international professional communication conference and Proceedings of the 18th annual ACM international conference on Computer documentation: technology & teamwork
Using knowledge engineering support for a Java documentation viewer
SEKE '02 Proceedings of the 14th international conference on Software engineering and knowledge engineering
Designing electronic reference documentation for software component libraries
Journal of Systems and Software
Associating search and navigation behavior through log analysis: Research Articles
Journal of the American Society for Information Science and Technology
Maintaining program understanding: issues, tools, and future directions
Nordic Journal of Computing
Proceedings of the 23rd annual international conference on Design of communication: documenting & designing for pervasive information
WikiWiki weaving heterogeneous software artifacts
Proceedings of the 2005 international symposium on Wikis
Documenting aspect-oriented PHP (AOPHP)
SIGDOC '06 Proceedings of the 24th annual ACM international conference on Design of communication
An online help framework for web applications
SIGDOC '07 Proceedings of the 25th annual ACM international conference on Design of communication
Automatic documentation inference for exceptions
ISSTA '08 Proceedings of the 2008 international symposium on Software testing and analysis
Commercial uses: Going functional on exotic trades
Journal of Functional Programming
Jadeite: improving API documentation using usage information
CHI '09 Extended Abstracts on Human Factors in Computing Systems
Journal of Systems and Software
Improving API documentation usability with knowledge pushing
ICSE '09 Proceedings of the 31st International Conference on Software Engineering
Listening to programmers Taxonomies and characteristics of comments in operating system code
ICSE '09 Proceedings of the 31st International Conference on Software Engineering
The next 700 programming libraries
Proceedings of the 2007 International Lisp Conference
Communicating bugs: global bug knowledge distribution
Information and Software Technology
Improving Web Service descriptions for effective service discovery
Science of Computer Programming
Automatic quality assessment of source code comments: the JavadocMiner
NLDB'10 Proceedings of the Natural language processing and information systems, and 15th international conference on Applications of natural language to information systems
aComment: mining annotations from comments and code to detect interrupt related concurrency bugs
Proceedings of the 33rd International Conference on Software Engineering
Canadian AI'11 Proceedings of the 24th Canadian conference on Advances in artificial intelligence
A literate experimentation manifesto
Proceedings of the 10th SIGPLAN symposium on New ideas, new paradigms, and reflections on programming and software
Codelets: linking interactive documentation and example code in the editor
Proceedings of the SIGCHI Conference on Human Factors in Computing Systems
High-performance language interoperability for scientific computing through Babel
International Journal of High Performance Computing Applications
What should developers be aware of? An empirical study on the directives of API documentation
Empirical Software Engineering
MCT: a tool for commenting programs by multimedia comments
Proceedings of the 2013 International Conference on Software Engineering
Data & Knowledge Engineering
| Hi-index | 0.00 |
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.