JAVA NAMING CONVENTIONS PDF
Java. Code Conventions. September 12, HotJava Views, HotJJavaChips, picoJava, microJava, UltraJava, JDBC, the Java Cup and. Naming Convention. Defining the naming convention is vital because they lead to greater consistency within your code and the code of your teammates. Greater . “Any fool can write code that a computer can understand. Improve the readability of code by providing a consistent level of quality Naming Conventions .. myavr.info
|Language:||English, Spanish, Portuguese|
|Genre:||Children & Youth|
|ePub File Size:||21.73 MB|
|PDF File Size:||10.49 MB|
|Distribution:||Free* [*Regsitration Required]|
java naming conventions, Let's learn what is naming convention and what are its benefits. This document is based directly on the Java Code Conventions document issued by Sun. Microsystems, Inc. The source document was. A Java source file is described as being in Google Style if and only if it adheres to the rules herein. aesthetic issues of formatting, but other types of conventions or coding standards as well. . Java code has a column limit of characters.
The first word of the member function should be a verb. Examples openAccount printMailingList save delete This results in member functions whose purpose can be determined just by looking at its name.
Examples getFirstName isPersistent 3.
Naming convention (programming)
Use prefix set to the name of the field. Examples setFirstName 3. Constructors are always given the same name as their class. Examples Customer SavingsAccount 3. The general rule is to be as restrictive as possible when setting the visibility of a member function. If member function doesnt have to be public then make it protected, and if it doesnt have to be protecte d than make it private. Include a history of any code changes Examples of how to invoke the member function if appropriate.
Applicable pre conditions and post conditions under which the function will work properly. These are the assumptions made during writing of the function. All concurrency issues should be addressed. Explanation of why keeping a function synchronized must be documented. If a member function is overloaded or overridden or synchronization changed, it should also be documented.
Note: Its not necessary to document all the factors described above for each and every member function because not all factors are applicable to every member function. Use single-line comments for business logic. Internally following should be documented: Control Structures This includes comparison statements and loops Why, as well as what, the code does Local variables Difficult or complex code The processing order If there are statements in the code that must be executed in a defined order 3.
Single blank lines to separate logical groups of code, such as control structures Two blank lines to separate member function definitions Specify the order of Operations: Use extra parenthesis to increase the readability of the code using AND and OR comparisons.
This facilitates in identifying the exact order of operations in the code Write short, single command lines Code should do one operation per line So only one statement should be there per line 5.
Examples firstName orderItems If the name of the field begins with an acronym then the acronym should be completely in lower case Example sqlDatabase 5. This makes it easy for a developer to identify the purpose of the components as well as its type. Accesors should be used for following purpose also: Initialize the values of fields Use lazy initialization where fields are initialized by their getter member functions.
This approach makes sense for constants that are stable. If the constants can change because of some changes in the business rules as the business matures then it is better to use getter member functions for constants.
By using accesors for constants programmer can decrease the chance of bugs and at the same time increase the maintainability of the system.
Collections, such as arrays and vectors, being more complex than single value fields have more than just standard getter and setter member function implemented for them. Because the business rule may require to add and remove to and from collections, accessor member functions need to be included to do so.
Example Member function type Getter for the collection Setter for the collection Insert an object into the collection Delete an object from the collection Create and add a new object into the collection Naming Convention getCollection setCollection insertObject deleteObject newObject Example getOrderItems setOrderItems insertOrderItems deleteOrderItems newOrderItem Note The advantage of this approach is that the collection is fully encapsulated, allowing programmer to later replace it with another structure It is common to that the getter member functions be public and the setter be protected Always Initialize Static Fields because one cant assume that instances of a class will be created before a static field is accessed 6.
Whenever a local variable is used for more than one reason, it effectively decreases its cohesion, making it difficult to understand. It also increases the chances of introducing bugs into the code from unexpected side effects of previous values of a local variable from earlier in the code. Note Reusing local variables is more efficient because less memory needs to be allocated, but reusing local variables decreases the maintainability of code and makes it more fragile 7.
Example: package org. The initial package name representing the domain name must be in lower case.
Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations unless the abbreviation is much more widely used than the long form, such as URL or HTML.
Parameter names, member variable names, and local variable names should be written in lowerCamelCase.
Example: firstName orderNumber lastName phoneNo id counter temp Constant Variable Constant variable names should be written in upper characters separated by underscores. These names should be semantically complete and clear.
Rethrow the exception. Many times you don't need to catch the exception at this level anyway, just let the method throw it. Remember: exceptions are your friend!
When the compiler complains you're not catching an exception, don't scowl. Smile: the compiler just made it easier for you to catch runtime problems in your code. Don't use finalizers Finalizers are a way to have a chunk of code executed when an object is garbage collected. While they can be handy for doing cleanup particularly of external resources , there are no guarantees as to when a finalizer will be called or even that it will be called at all.
Android doesn't use finalizers. In most cases, you can do what you need from a finalizer with good exception handling. If you absolutely need it, define a close method or the like and document exactly when that method needs to be called see InputStream for an example.
In this case it is appropriate but not required to print a short log message from the finalizer, as long as it is not expected to flood the logs. Fully qualify imports When you want to use class Bar from package foo, there are two possible ways to import it: import foo. Bar; Makes it obvious what classes are actually used and the code is more readable for maintainers. Use import foo. Bar; for importing all Android code. An explicit exception is made for java standard libraries java.
Java library rules There are conventions for using Android's Java libraries and tools. In some cases, the convention has changed in important ways and older code might use a deprecated pattern or library.
When working with such code, it's okay to continue the existing style. When creating new components however, never use deprecated libraries. Java style rules Use Javadoc standard comments Every file should have a copyright statement at the top, followed by package and import statements each block separated by a blank line and finally the class or interface declaration.
Review of ESET...
In the Javadoc comments, describe what the class or interface does. Blah; import android. Yada; import java.
ResultSet; import java. This sentence should start with a third person descriptive verb. If the method does something more complex such as enforcing a constraint or has an important side effect , then you must document it.Note Reusing local variables is more efficient because less memory needs to be allocated, but reusing local variables decreases the maintainability of code and makes it more fragile 7.
Braces are used around all statements, even single statements, when they are part of a control structure, such as a if-else or for statement. The primary goal for line wrapping is to have clear code, not necessarily code that fits in the smallest number of lines.
The rare exception to this rule is test code and top-level code where you want to catch all kinds of errors to prevent them from showing up in a UI, or to keep a batch job running. Using the is prefix solves a common problem of choosing bad boolean names like status or flag.