published

(with the agreement of the original author)
by marc.meurrens@acm.org (http://homepages.ulb.ac.be/~meurrens)

URL of the original document

http://www.chimu.com/publications/javaStandards/index.html
by Mark L. Fussell (Mark.Fussell@ChiMu.com)

URL of our page(s) on "Java OO Design & Coding Standards"

(where this document is referred as detailled below):
http://www.ulb.ac.be/esp/ip-Links/Java/joodcs/index.html
[back]

Java Development Standards

is a revisited mirror (with the original author's agreement) of http://www.chimu.com/publications/javaStandards/index.html by Mark L. Fussell (Mark.Fussell@ChiMu.com) This document describes the standards (Coding and Design Standards) used by Mark L. Fussel for Java development. The reason to provide these standards is to help users of his 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.
This is a ressource you must read!
(about 15 pages all mirrored on our site; with figures in the 2nd part (design notations); the document includes references to a clever selection of printed and online books)

Pre-prepared links (to this document)

A list of approx. 43 "pre-prepared" links to this page is available at URL http://www.ulb.ac.be/esp/ip-Links/Java/joodcs/fussel-LinksTo.html.
These links are (or will be) used in other pages related to "OO design and Coding Standards".

Revisions

• August 5 & 6, 1997 list of "pre-prepared" links, enhanced feedback form.
• July 8, 1997 mirroring version: June 15, 1997 - v0.7 [mlf-970615]

ChiMu  Publications

TOC Next

Java Development Standards

v0.7 [mlf-970615]

Mark L. Fussell

Mark.Fussell@ChiMu.com

www.chimu.com

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

	ChiMu  Publications  Java Development Standards	TOC Next
	Copyright (c) 1997, Mark L. Fussell.

Brussels July 8, 1997 mirror of June 15, 1997 - v0.7 [mlf-970615] by Mark L. Fussell (Mark.Fussell@ChiMu.com) published by marc.meurrens@acm.org (http://homepages.ulb.ac.be/~meurrens) original URL: http://www.chimu.com/publications/javaStandards/index.html current URL: http://www.ulb.ac.be/esp/ip-Links/Java/joodcs/MarkFussell.html internet programming Links: http://www.ulb.ac.be/esp/ip-Links (ip-Links) Université Libre de Bruxelles: http://www.ulb.ac.be (ULB) La Cambre - Architecture: http://www.lacambre-archi.be Belgian JAVA User Group: http://www.bejug.org (BeJUG)

 

Use this form to send your feedback and/or submit a link From your e_mail : your URL : To sja@bejug.org ; Mark.Fussell@ChiMu.com ; meurrens@ulb.ac.be Subject Link Comment

 

Conventions used in these pages: html file, text file or java or CPP source located on our site download area (on our site) or file to be downloaded (use the right button of your mouse) document on a belgian academic or scientific site document (on another site) or link to be fixed or link we didn't visit/evaluate; documents indicated with their full URL will be displayed in their own "top" window. ftp download or file to be downloaded (use the right button of your mouse) indicates a "mailto" link. and indicate links added or updated within the last month. Click on the separator to reach a higher level in the page or site hierarchy.

 

back home e_mail ULB ESP ip-Links La Cambre BeJUG