Java Code Conventions
Short summary:
example of a Java program properly formatted, see "Java Source File Example" on page ... Java programs can have two kinds of comments: implementation comments and ...
Long summary:
Java Code Conventions 2 File Names 1 Java Code Conventions 1 Introduction 1.1 Why Have Code Conventions Code conventions are important to programmers for a number of reasons: 80% of the lifetime cost of a piece of software goes to maintenance. Hardly any software is maintained for its whole life by the original author. Code conventions improve the readability of the software, allowing engineers to understand new code more quickly and thoroughly. If you ship your source code as a product, you need to make sure it is as well packaged and clean as any other product you create. For the conventions to work, every person writing software must conform to the code conventions. Everyone. 1.2 Acknowledgments This document reects the Java language coding standards presented in the Java Language Specication, from Sun Microsystems, Inc. Major contributions are from Peter King, Patrick Naughton, Mike DeMoney, Jonni Kanerva, Kathy Walrath, and Scott Hommel. This document is maintained by Scott Hommel. Comments should be sent to shommel@eng.sun.com 2 File Names This section lists commonly used le sufxes and names. 2.1 File Sufxes Java Software uses the following le sufxes: File Type Sufx Java source .java Java bytecode .class 3 File Organization 2 2.2 Common File Names Frequently used le names include: 3 File Organization A le consists of sections that should be separated by blank lines and an optional comment identifying each section. Files longer than 2000 lines are cumbersome and should be avoided. For an example of a Java program properly formatted, see Java Source File Example on page 18. 3.1 Java Source Files Each Java source le contains a single public class or interface. When private classes and interfaces are associated with a public class, you can put them in the same source le as the public class. The public class should be the rst class or interface in the le. Java source les have the following ordering: Beginning comments (see Beginning Comments on page 2) Package and Import statements Class and interface declarations (see Class and Interface Declarations on page 3) 3.1.1 Beginning Comments All source les should begin with a c-style comment that lists the class name, version information, date, and copyright notice: /* * Classname * * Version information * * Date * * Copyright notice */ File Name Use GNUmakefile The preferred name for makeles. We use gnumake to build our software. README The preferred name for the le that summarizes the contents of a particular directory. 3 File Organization 3 3.1.2 Package and Import Statements The rst non-comment line of most Java source les is a package statement. After that, import statements can follow. For example: package java.awt; import java.awt.peer.CanvasPeer; 3.1.3 Class and Interface Declarations The following table describes the parts of a class or interface declaration, in the order that they should appear. See Java Source File Example on for an example that includes comments. Part of ...
Source: www.literateprogramming.com
Related
Java Programming Language SL275, language; objectoriented programming. with
the Java programming language; and ...
SL275: Java Programming Language. 2 of 5.
Sun Educational Services ...,
more
Java Programming Language Workshop SL285, the basic structure and syntax of the
Java. programming language who need to
... Java programming language. Understand
basic Unified ...,
more
Java Programming and Information hiding principle, Introduction to Java Programming. 3.
Structure of Object. oriented program ....
Introduction to Java Programming. 7. Lets
execute a Java program. Compile ...,
more
