Original source: http://java.sun.com/docs/codeconv/html/codeconvtoc.doc.html, translation source: http://morningspace.51.net/ ,moyingzz@etang.com 1 Introduction 1.1 Why do you have a code specification code specification for programmers, and have the following reasons: - A software life cycle, 80% of the cost is maintenance - almost no software, in its entire life cycle, all Maintaining the initial developers - coding specifications can improve software readability, allowing programmers to completely understand new code as soon as possible - if you release the source code as a product, you need to make it very good to package And clear, one other product you have built In order to implement the specification, each software developer must consistently abide by the coding specification. 1.2 Copyright Notice This document reflects the coding standard part in Sun Microsystems, Java language norms. The main contributors include: Peter King, Patrick Naughton, Mike Demoney, Jonni Kanerva, Kathy Walrath, and Scott Hommel. This document is now maintained by Scott Hommel, please send to Shommel@eng.sun.com 2. The file name lists the common file name and its suffix. 2.1 File suffix Java program uses the following file suffix
File Category File suffix java source file .javajava bytecode file .class2.2 Common file name Java program uses the following file suffix
File Category File suffix java source file .javajava bytecode. Class 3. The file is organized by a file being splitted by the spacer and identifies an optional annotation of each paragraph. More than 2,000 rows of procedures are difficult to read and should be avoided as much as possible. "Java Source File Example" provides a reasonable Java program example. 3.1java Source File Each Java source file contains a single public class or interface. If private and interfaces are associated with a public class, they can put them and public classes in the same source file. The public category must be the first class or interface in this file. The Java source file also follows the following rules: - Start comments (see "Opening Note") - Packages and introduction statements (see "Package and Introduction Statements) - Class and Interface Declaration (see" Class and Interface Declaration "3.1.1 Note All source files should have a C language style annotation in the beginning, where the class name, version information, date, and copyright statement: / *
* ClassName
*
* Version Information
*
* Date
*
* CopyRight Notice
* / 3.1.2 Package and introduction statements In most Java source files, the first non-note line is a packet statement. You can follow the introduction statement after it. For example: package java.aw;
Import java.awt.peer.canvaspeer; 3.1.3 Class and Interface Description The following table describes the various parts of the class and interface declarations and the order of the appearance. See "Java Source File Example" An example of a comment.
Particular / Interface Declaration of Part 1 / Interface Document Note (/ ** ... * /) This annotation is included in this comment, see "Document Notes" 2 or Interface Declaration 3 / Interface Implementation (/ * ... * /) If necessary, the comment should contain any information about the entire class or interface, and this information is not suitable as a class / interface document comment. The 4 types of (static) variables are firstcoming the common variables of the class, followed by the protection variable, and then the package level variable (no access modifier, access modifier), and finally the private variable. 5 instance variables are first common, followed by the protection level, and then the package level (no access to the modifier), and finally the private level. 6 Structure 7 Methods These methods should be packet according to functions, rather than scope or access. For example, a private class method can be placed between two public instance methods. Its purpose is to make it easier to read and understand the code. 4. The indentation of 4 spaces are often used as a unit of retaining plate. The exact interpretation of indentation is not specified in detail (space VS. Table). A tab is equal to 8 spacers (rather than 4). 4.1 The longness of the period is as long as possible to avoid a row of more than 80 characters, as many terminals and tools cannot be treated well. Note: The examples used in the document should use a shorter chance, and the length is generally not more than 70 characters. 4.2 Renewal When an expression cannot be accommodated in one line, it can be disconnected according to the following general rules: - Disconnect behind a comma - disconnected in front of an operator - Ning better Higher-Level Open, not the low-level (Lower-Level) - New line should be aligned with the beginning of the same level expression - If the above rules have caused your code to confuse or make your code piled up on the right Then, it is ingenuity to indent the 8 spaces. The following is some examples of disconnect calls: SomeMethod (LONGEXPIPRESSION1, LONGEXPIPRESSION2, LONGEXPRESSION3, LONGEXPRESSION4, LONGEXPRESSION5);
Var = SomeMethod1 (LONGEXPRESSION1,
SomeMethod2 (LONGEXPRESSION2,
LONGEXPRESSION3)); The following is an example of two breakdown spell expressions. The former is better because the disconnect is located outside the bracket expression, which is a higher level of disconnection. Longname1 = longname2 * (longname3 longname4 - longname5)
4 * longname6; // preffer
Longname1 = longname2 * (longname3 longname4
- longname5) 4 * longname6; // Avoid The following is an example of two indentation methods declarations. The former is a conventional situation. If the latter uses a routine indentation method, the second line and the third row are moved very rely very, so the generation is indented in 8 space // conventional Indentation.
SomeMethod (int Anarg, Object Anothererarg, String Yetanotherarg,
Object andstillanother {
...
}
// Indent 8 spaces to avoid very deep indents
Private static synchronized horkinglongmethodname (int Anarg,
Object Anotherarg, String Yetanothererarg,
Object andstillanother {
...
} The line break of the IF statement usually uses the rules of 8 spaces, as regular indentation (4 spaces) will make the statement look much more effort. For example: // don't use this indentation
IF (Condition1 && Condition2) || (Condition3 && Condition4)
||! (Condition5 && condition6)) {// bad wraps
DOSMETHINGABOUTIT (); // make this line easy to miss
}
// use this indeetation instead
IF (Condition1 && Condition2)
|| (Condition3 && Condition4)
||! (Condition5 && condition6)) {
DOSMETHINGABOUTIT ();
}
// or us
IF (Condition1 && Condition2) || (Condition3 && Condition4)
||! (Condition5 && condition6)) {
DOSMETHINGABOUTIT ();
}
There are three feasible methods here for processing three-yuan arithmetic expression: alpha = (AlongBooleaneXpression)? Beta: gamma;
Alpha = (AlongBooleaneXpression)? Beta
: gamma;
Alpha = (AlongBooleaneXpression)
? beta
: gamma; 5. Note The Java program has two types of annotations: Implementation Comments and Document Comments. Realizing comments are those who have seen in C , use /*...*/ and // definitions. Document Note (known as "DOC Comments") is a unique java and is defined by / the / **.... Document comments can be converted to an HTML file through the JavaDoc tool. Realize comments to comment code or implement detail. Document Note describes the code from the perspective of the IMPLEMentation-Free. It can be read by those developers who have no source code. Note Should be used to give a summary of the code and provide additional information provided by code itself. Note Should only include information related to the reading and understanding procedures. For example, information such as how the corresponding packet is established or in which directory should not be included in the comment. In the comment, it is possible to explain the important or not obvious place in design decisions, but it should be avoided. Excessive annotations are easy to obsolete. It is usually avoided that the code updates may be more comments. Note: Frequent comments sometimes reflect the low quality of the code. When you feel forced to add anything, consider rewriting the code clearer. Comments should not be written in the big boxes drawn in an asterisk or other character. Note Should not include special characters such as patriant characters and backfall. 5.1 Format Program for Remove Note You can have four things that implement annotations: block, single-line, tail, and end-of-line. 5.1.1 Block Comment Block Comments are often used to provide descriptions of files, methods, data structures, and algorithms. Block comments are placed at the beginning of each file and before each method. They can also be used elsewhere, such as internal interior. Block note inside features and methods should have the same indentation format with the code they described. The first block of the block should have a blank line, which is used to discrolize block annotations and code, such as: / *
* Here is a block Comment.
* / Block Note You can start with / * - so that Indenter can identify the beginning of a code block without rearing it. / * -
* Here Is A Block Comment with some very special * Formatting That I Want Indent (1) to ignore.
*
* One
* TWO
* Three
* / Note: If you don't use Indenter, you don't have to use / * -, or to run Indenter for others in your code. See "Document Notes" 5.1.2 Untrial Note Short Note You can be displayed within one line and have the same indented level with the subsequent code. If a note cannot be written within one line, it will be used (see "Block Comment"). There should be an empty line before a single line comment. The following is an example of a single-line annotation in a Java code: if (condition) {
/ * Handle the condition. * /
...
}
5.1.3 Note Note Totet Note You can be in the same row with the code they want, but there should be sufficient blank to separate the code and comments. If there is a plurality of short comments appear in large segment code, they should have the same indentation. The following is an example of the tail end annotation in a Java code: if (a == 2) {
Return True; / * Special Case * /
} else {
Return isprime (a); / * Works Only for ODD A * /
}
5.1.4 Lines Note Comment Defense "//", you can comment out part of the row or a line. It is generally not used for annotation text; however, it can be used to comment out of the continuous multi-line code segment. The following is an example of all three styles: if (foo> 1) {
// Do a double-flip.
...
}
Else {
Return false; // explain why here.
}
// if (bar> 1) {
//
// // do a triple-flip.
// ...
//}
// else {
// Return False;
//}
5.2 Document Note Note: See "Java Source File Example" here, see "How to Write Doc Comments for Javadoc", which contains information about document comment tags (@return , @Param, @see): http://java.sun.com/javadoc/writingdoccomments/index.html To learn more about document comments and javadoc, see Javadoc's homepage: http: // java. Sun.com/javadoc/index.html Document Note Description Java class, interface, constructor, method, and field (field). Each document comment will be placed in the comment delimiter / **...*/, a comment corresponds to a class, interface or member. This comment should be before: / **
* The Example Class Provide ...
* /
Public class example {...
Note that the top-level and interfaces are not indent, and their members are indent. The first row (/ **) describing the document annotation of the classes and interfaces does not need to be indented; the subsequent document comments are indented in each row (align the asterisk). Members, including constructor, the first line of its document comments indent 4 grids, and then indent the 5 grid per line. If you want to give information about classes, interfaces, variables, or methods, and this information is not suitable for writing in the document, you can use the implementation block annotation (see 5.1.1) or tightly follow the separate note behind the declaration (see 5.1.2). For example, the details of a class implementation should be placed in a block annotation that keeps followed by the class declaration, not in the document comment. Document comments cannot be placed in a definition block of a method or constructor, since Java will associate the first declaration after the document comment is associated with it. 6 Declaration 6.1 The number of declared variables per line is recommended to a row, because this is conducive to writing comments. That is, int level; // indentation level set; // size of table
It is better than, int Level, size; do not put declaration of different types of variables in the same line, for example: int foo, fooarray []; // wrong!
Note: A space is placed between the type and the identifier between the type and the identifier, and the alternative way to be allowed is Tab: int level; // Indentation Level
Int size; // size of table
Object CurrenTry; // Currently Selected Table Entry
6.2 Initialization is initialized while declaring local variables. The only reason not to do this is that the initial value of the variable depends on some previous calculations. 6.3 The layout is only declared at the beginning of the code block. (A block refers to any code that is included in the middle of braces "{" and "}".) Do not declare when the variable is used for the first time. This will make the programs that are not concentrated, and the transplantability of the code is hindered in this scope. Void mymethod () {
INT INT1 = 0; // Beginning of Method Block
IF (Condition) {
INT INT2 = 0; // Beginning of "if" block
...
}
}
One exception to this rule is the index variable for the FOR cycle (INT i = 0; I Avoid a local variable that covers a variable of the previous declaration. For example, do not declare the same variable name in the internal code block: int count; ... mymethod () { IF (Condition) { INT count = 0; // avoid! ... } ... } 6.4 Category and Interface Declaration When writing classes and interfaces, the following format rules should be followed: - The left parentheses before the method name and its parameter list "(" Do not have spaces - left braces "{" at the end of the declaration statement - Right Big Brand "}" is one row, aligned with the corresponding statement, unless an empty statement, "}" should follow "{" Class Sample Extends Object { INT IVAR1; INT IVAR2; Sample (int i, int j) { Ivar1 = i; Ivar2 = j; } Int emptymethod () {} ... } - Method and method Separate 7 statement 7.1 simple statement, each row, including one statement, for example: Argv ; // Correctargc--; // Correct Argv ; argc--; // avoid! 7.2 Composite statement composite statement is a statement sequence contained in braces, such as "{statement}". For example, the following paragraphs. - Included in which the statement should be compained in a hierarchy - left braces "{" should be located at the end of the initial line of the complex statement; the right braces "}" should be partially row and composite statement . - Brackets can be used for all statements, including a single statement, as long as these statements are part of the IF-ELSE or FOR control structure. This makes it easy to add a statement without worrying to introduce bugs due to adding parenthesis. 7.3 Returning Statements A RETURN statement with return values does not use parentheses "()" unless they make the return value more apparent in some way. Return; Return mydisk.size (); RETURN (SIZE? SIZE: DEFAULTSIZE); 7.4 IF, IF-ELSE, IF ELSE-IF ELSE Statement IF-ELSE statement should have the following format: if (condition) { STATEMENTS; } IF (Condition) { STATEMENTS; } else { STATEMENTS; } IF (Condition) { STATEMENTS; } else if (condition) { STATEMENTS; } else { STATEMENTS; } Note: The IF statement is always enclosed in "{" and "}" to avoid using the following easy format: if (condition) // avoid! This omits the braces {}! STATEMENT; 7.5 for statement a for statement should have the following format: for (Initialization; Condition; Update) { STATEMENTS; } An empty FOR statement (all work is completed in initialization, conditional judgment, update clause) should have the following format: for (Initialization; Condition; Update); when using a comma in the initialization of the for statement or update clause Avoids the use of three or more variables, resulting in an increase in complexity. If necessary, use a separate statement before the FOR cycle (for the initialization subsis) or the FOR cycle (for the update clause). 7.6 WHILE statement a while statement should have the following format while (condition) { STATEMENTS; } An empty While statement should have the following format: While (condition); 7.7 Do-While Statement A Do-While Statement should have the following format: do { STATEMENTS; WHILE (condition); 7.8 Switch statement A Switch statement should have the following format: switch (condition) { Case ABC: STATEMENTS; / * Falls through * / Case Def: STATEMENTS; Break; Case XYZ: STATEMENTS; Break; DEFAULT: STATEMENTS; Break; } Whenever a CASE is executed down (because there is no BREAK statement), you should usually add a comment at the location of the BREAK statement. In the sample code above, comments / * falls through * /. 7.9 Try-catch statement A try-catch statement should have the following format: Try {statements; } catch (exceptionclass e) { STATEMENTS; } It may also follow a final-catch statement, regardless of whether the TRY code block is successful, it will be executed. Try { STATEMENTS; } catch (exceptionclass e) { STATEMENTS; } finally { STATEMENTS; } 8 blank 8.1 Dark Dark Divide Separate the logical code segment to improve readability. The following conditions should always use two space lines: - a source file between two sections - class declarations and interface declarations should always use an empty line: - Between two methods - method Between the first statements of local variables and methods - block comments (see "5.1.1") or single-line comments (see "5.1.2") - between two logic segments within a method, Improve readability 8.2 Spaces The following conditions should be used: - a keyword that follows parentheses should be separated by spaces, for example: while { ... } Note: The space should not be placed between the method name and the left brackets. This will help distinguish between keywords and method calls. - Blank should be in the back of the comma in the parameter list - all binary operators, except ".", You should use spaces to separate from the operand. The one-dollar operator and the operand is not due to the splitter, such as: negative (" ") and self-reduction ("-"). For example: A = C D; A = (a b) / (c * d); While (D = s ) { N ; } PRINTSIZE ("Size IS" FOO "/ N"); - The expression in the for statement should be separated by spaces, for example: for (expr1; expr2; expr3) - It should be followed by a space after compulsory transformation, for example: MyMethod ((Byte) Anum, (Object) x); MyMethod ((int) (CP 5) ((int) (I 3)) 1); 9 Naming Specifications Named Specification makes the program easier to read, making it easier to understand. They can also provide information about identifier functions to help understand code, for example, whether it is a constant, package, or class. Identifier Type Name Rules Example Pack (Packages) A unique package prefix is always lower-write ASCII letters and is a top domain name, usually COM, EDU, GOV, MIL, NET, ORG, or 1981 ISO 3166 Standard Specified English Double Character Code in the country. The subsequent part of the package is not the same as the naming specification within the respective mechanisms. Such naming specifications may distinguish between departments, projects, or registration names in a specific directory name. com.sun.engcom.apple.quicktime.v2edu.cmu.cs.bovik.chese class (Classes) Names Rules: Classified is a word, using case-by-case mixing, the first letter of each word. Try to make your class name simple and description. Use intact words to avoid abbreviations (unless the abbreviation words are more widely used, like url, html) class rasser; Class ImageSprite; interface (interfaces) Naming rules: case-sensitive rules are similar to Interface RasterDelegate; interface storing; method Methods) method name is a verb, which uses cases of cases mixed, and the first letter of the first word is lowercase, the first letter of the words. Run (); Runfast (); getBackground (); variable (variables) In addition to the variable name, all instances, including classes, types, usual, using case-write mix, the first letter of the first letter, after the word The initial letters. The variable name should not begin with the scribe or dollar symbol, although this is allowed in grammar. The variable name should be short and described. The selection of the variable name should be easy to remember, that is, it can be pointed out. Try to avoid a variable name of a single character unless it is a disposable temporary variable. Temporary variables are usually named I, J, K, M and N, which are generally used for integer; C, D, E, which are generally used for characters. CHAR C; INT i; FLOAT MYWIDTH; instance variable (instance variables) case, in addition to the number of variable names, in addition to a downline int _employeid; string _name; Customer _CUSTOMER; constant (constants), a statement, and ANSI constants, should All uppercase, interlaced interlaced in words. (Try to avoid ANSI constants, easy to cause errors) Static final int max_width = 4; static final int max_width = 999; Static Final INT GET_THE_CPU = 1; 10 Programming Formula 10.1 Provides access control for instances and class variables If there is not enough reason, don't State an example or class variable as public. Typically, instance variables do not require explicit settings (SET) and gotten, which is usually produced as the edge effect of method calls (Side Effect). A proper example of a public instance variable is that the class is only the data structure, no behavior. That is, if you want to use a structure rather than a class (if the Java supports the structure), then the instance variable declaration of the class is suitable. 10.2 Reference class variables and class methods Avoid access to a class of static variables and methods with an object. You should be replaced by a class name. For example: classMethod (); //okaclass.classmethod (); // ok ANOBJECT.CLASSMETHOD (); //aVOID! 10.3 The constant is located in the FOR cycle as a digital constant of the counter value, except -1, 0 and 1, should not be written directly to code. 10.4 Variable assignment avoids the same value to multiple variables in one statement. It is hard to read. For example: foobar.fchar = barfoo.lchar = 'c'; // Avoid! Do not use the assignment operator to be confused with the equivalent relationship operator. For example: IF (C = D ) {// Avoid! (Java Disallows) ... } It should be written into IF ((C = D )! = 0) { ... } Do not use embedded assignment operators to try to improve the efficiency of runtime, which is the work of the compiler. For example: d = (a = b c) r; // avoid! It should be written as a = B C; D = a r; 10.5 Other Formulations 10.5.1 Parentheses In general, the use of parentheses in an expression containing a variety of operators to avoid operator priority issues, it is a good way. Even if the priority of the operator may be clear, it is not necessary for others. You can't assume that other programmers are as clear as you know the priority of the operator. IF (a == b && c == d) // Avoid! IF ((a == b) && (c == d)) // Right 10.5.2 Return The value is trying to make your program structure in accordance with the purpose. For example: if (booleaneXpression) { Return True; } else { Return False; } It should be in this way as follows: Return BooleaneXpression; Similarly: IF (Condition) { Return X; } Return Y; Should be written: return (condition? X: y); 10.5.3 Conditional Operators "?" Before the expression of a binary operator appears in the ternary operator "?:" "?", You should add a pair of parentheses to the expression. For example: (x> = 0)? X: -x; 10.5.4 Special Note Use XXX in the comment to identify some of the content that does not implement (BOGUS) but works. Use fixme to identify certain fake and wrong content 11 Codes 11.1 Java Source File Example The following example, showing how to lay out a Java source program containing a single public class. The layout of the interface is similar. See "Class and Interface Declaration" and "Text Refidence". / * * @ (#) Blah.java 1.82 99/03/18 * * CopyRight (C) 1994-1999 Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. * All Rights Reserved. * * This Software Is The Confidential and ProPrietary Information of Sun * Microsystems, Inc. ("Confidential Information"). You Shall NOT * Disclose Such Confidential Information and Shall Use It Only in * Accordance with The Terms of The License Agreement You Entered Into * with sun. * / Package java.blah; Import java.blah.blahdy.blahblah; / ** * Class Description Goes Here. * * @version 1.82 18 Mar 1999 * @Author firstname lastname * / Public class blah extends someclass { / * A class implementation common can go here. * / / ** Classvar1 Documentation Comment * / Public static int classvar1; / ** * Classvar2 Documentation Comment That Happens To BE * More Than One Line Long * / Private static object classvar2; / ** Instancevar1 Documentation Comment * / Public Object Instancevar1; / ** Instancevar2 Documentation Comment * / Protected int instancevar2; / ** Instancevar3 Documentation Comment * / Private object [] instancevar3; / ** * ... Constructor Blah Documentation Comment ... * / Public blah () { // ... Implementation Goes Here ... } / ** * ... Method Dosomething Documentation Comment ... * / Public void dosomething () { // ... Implementation Goes Here ... } / ** * ... Method Dosomethingelse Documentation Comment ... * @Param SomeParam Description * / Public void Dosomethingelse (Object SomeParam) { // ... Implementation Goes Here ... } }
