tailieunhanh - Java Programming Style Guidelines

This document lists Java coding recommendations common in the Java development community. The recommendations are based on established standards (see for instance [1], [2], [3], [4] and [5]) as well as feedback from a huge number of software professionals around the world. Main drawback with existing guidelines is that these guides are far too general in their | Java Programming Style Guidelines Seite 1 von 13 Java Java Programming Style Guidelines Version January 2004 Geotechnical Software Services Copyright 1998-2004 This document is available at http Table of Content 1 Introduction o Layout of the Recommendations o Recommendations Importance 2 General Recommendations 3 Naming Conventions o General Naming Conventions o Specific naming Conventions 4 Files 5 Statements o Package and Import Statements o Classes and Interfaces o Methods o Types o Variables o Loops o Conditionals o Miscellaneous 6 Layout and Comments o Layout o White space o Comments 7 References 1 Introduction This document lists Java coding recommendations common in the Java development community. The recommendations are based on established standards see for instancefl 2 3 4 and 51 as well as feedback from a huge number of software professionals around the world. Main drawback with existing guidelines is that these guides are far too general in their scope and that more specific rules especially naming rules need to be established. Also the present guide has an annotated form that makes it far easier to use during project code reviews than most other existing guidelines. In addition programming recommendations generally tend to mix style issues with language technical issues in a somewhat confusing manner. The present document does not contain any Java technical recommendations at all but focuses mainly on programming style. While a given development environment IDE can improve the readability of code by access visibility color coding automatic formatting and so on the programmer should never rely on such features. Source code should always be considered larger than the IDE it is developed within and should be written in a way that maximize its readability independent of any IDE. Layout of the Recommendations. The recommendations are grouped by topic and each .