www.AmbySoft.com/javaCodingStandards.pdf Copyright 1998-1999 AmbySoft Inc.
Purpose of this White Paper
This white paper describes a collection of standards, conventions, and guidelines for writing solid Javacode. They are based on sound, proven software engineering principles that lead to code that is easy tounderstand, to maintain, and to enhance. Furthermore, by following these coding standards yourproductivity as a Java developer should increase remarkably – Experience shows that by taking the time towrite high-quality code right from the start you will have a much easier time modifying it during thedevelopment process. Finally, following a common set of coding standards leads to greater consistency,making teams of developers significantly more productive.
Important Features of This White Paper
Existing standards from the industry are used wherever possible – You can reuse more than just code.
The reasoning behind each standard is explained so that you understand why you should follow it.
Viable alternatives, where available, are also presented along with their advantages and disadvantagesso that you understand the tradeoffs that have been made.
The standards presented in this white paper are based on real-world experience from numerous object-oriented development projects. This stuff works in practice, not just theory.
These standards are based on proven software-engineering principles that lead to improveddevelopment productivity, greater maintainability, and greater enhancability.
Professional software developers who are interested in:
Writing Java code that is easy to maintain and to enhance
Increasing their productivity
Working as productive members of a Java development team
Help Me Improve These Standards
Because I welcome your input and feedback, please feel free to email me firstname.lastname@example.org yourcomments and suggestions. Let’s work together and learn from one another.
The following people have provided valuable input into the development and improvement of thesestandards, and I would like to recognize them for it.Stephan MarceauLyle ThompsonDavid PinnLarry VirdenEva GreffWayne ConradMichael AppelmansWilliam GilbertGraham WrightAlex SantosKiran AddepalliBrian SmithLarry AllenDick SalisburyBruce ConradMichael FinneyJohn PintoVijay EluriCarl ZimmermanHakan SoderstromBill SiggelkowCamille BellFredrik NystromCory Radcliff Kathy EckmanGuy SharfScott HarperKyle LarsonRobert MarshallPeter C.M. HaightMark BrouwerGerard BroeksteegHelen Gilmore
Scott W. AmblerJanuary 2000