Skip to content
jimburton edited this page Jul 3, 2013 · 6 revisions

Follow the Java coding conventions in The Elements of Java Style. Contributions that don't follow these guidelines are not likely to be accepted.

New packages should contain a file called package-info.java that includes a brief description of the purpose of the package. New classes (and new package-info.java files) must include a multiline comment such as this at the beginning of the file:

/**
 * This class sets the controls for the heart of the sun.
 * 
 * Copyright (c) 2013 The BigArrow authors (see the file AUTHORS).
 * See the file LICENSE for copying permission.
 *
 * @author YOUR_NAME
 *
 */

In addition, brief method-level javadoc comments should always be supplied. Inline comments should be used sparingly.

Clone this wiki locally