Coding Style 

Java Coding Style Guide

PDF document from Sun; 200k

Code Conventions 

Acquire multiple locks in a fixed, global order to avoid deadlock

-

Use exceptions effectively in your programs

-

Use exception chaining to preserve debugging information

-

Use message catalogs for easy localization

-

More Exceptional Java

-

Comments/Javadoc 

How to Write Doc Comments for the Javadoc Tool

This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Sun Microsystems

Javadoc Tool

Javadoc is a tool for generating API documentation in HTML format from doc comments in source code.

Requirements for Writing Java API Specifications

This document describes the requirements for writing API specifications for the Java platform.

Get Your Filthy Tags Out Of My Javadoc, Eugene

Guidelines for effective Javadoc commenting

I have to document THAT?

The Java language takes an integrated approach to API documentation through the Javadoc comment convention. The Javadoc tool can help generate pretty API documentation, but the vast majority of Java API documentation out there is simply awful. Because it is part of the source code, the responsibility for the documentation of APIs falls squarely on the engineer. In this article, Brian rants about the current state of Java documentation practices and offers some guidelines on how to write more useful Javadoc.

Reader Feedback