Java Development Standards

v0.7 [mlf-970615]

Overview

This document describes the standards I use for Java development. The reason to provide these standards is to help users of my frameworks to more easily understand and predict the interfaces of the subsystems. These standards may also be helpful to teams establishing or growing their own standards.

Table of Contents

• Overview
  • Sources of Standards
  • Definition of terms:
• Coding and Design Standards
  • Classes, Interfaces, Types and Protocol standards
    • Summary
    • Interface and Class naming
    • Types and protocols
    • Access Control
    • A note on abbreviations
    • Constructors and Factory methods
    • Pack Objects
  • Method Standards
    • Summary
    • Intention revealing method names
    • Standard method name patterns
    • Java method signatures
    • Standard for method signatures
    • Parameter positions woven into the method name
    • Attributes
    • Instance variables
  • Source code format
    • Sectioning
    • Comments
    • Interfaces and comments
    • Keyword Order
• Design Notation
  • Objects and Classes
    • Class Names
    • Methods
    • Attributes
    • Instance Variables
    • Message Sends
    • Shorthand for hand drawings
  • Types
    • Shorthand for hand drawings
  • Relationships
    • Kilov and Ross relationship types
  • Code Blocks
  • Other Notations
    • Functor
    • Enhancement
    • Private Functionality
• Standard Definitions
• References

Other Versions

• PDF Format