Java code conventions

From Icbwiki

Jump to: navigation, search

This page describes the basic coding conventions for the Java programming language that have been adopted by the ICB. The ICB tends to follow the Java Code Conventions suggested by Sun fairly closely. Specific details are provided in the sections below.

Contents

Naming Conventions

Package Names 
Package names should start with edu.cornell.med.icb. Package names should not include dashes, underscores or any capital letters.
Class Names 
Variable Names 
Constants 

Project Layout

Ant

Subversion

Documentation

Header

Javadocs

Recommended Conventions

Dealing with InterruptedException

InterruptedExceptions should not be ignored. See http://www-128.ibm.com/developerworks/java/library/j-jtp05236.html

Useful Third Party Packages

The following section describes packages that have been proven to be useful for development.

Commons Lang 
Helper utilities for java including string manipulation methods, basic numerical methods, object reflection, creation and serialization, and system properties.
Commons I/O 
A library of utilities to assist with developing I/O functionality.

Tools

Links

Personal tools