Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Scribd Logo
Upload

Welcome to Scribd!

  • 319 views

    Java Coding Standard

    Uploaded by

    Aileen Nicole Ayala
    This document provides a coding standard template for Java programs. It outlines guidelines for program structure and formatting, including using descriptive headers, comments, and indenting. Sections cover naming identifiers, capitalization, spacing, commenting code, and dividing code into logical major sections. The goal is to guide developers to write clear, readable Java code.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd

    Java Coding Standard

    Uploaded by

    Aileen Nicole Ayala
    319 views4 pages
    This document provides a coding standard template for Java programs. It outlines guidelines for program structure and formatting, including using descriptive headers, comments, and indenting. Sections cover naming identifiers, capitalization, spacing, commenting code, and dividing code into logical major sections. The goal is to guide developers to write clear, readable Java code.

    Original Description:

    Example of a Java Coding Standard

    Copyright

    © © All Rights Reserved

    Available Formats

    DOCX, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    This document provides a coding standard template for Java programs. It outlines guidelines for program structure and formatting, including using descriptive headers, comments, and indenting. Sections cover naming identifiers, capitalization, spacing, commenting code, and dividing code into logical major sections. The goal is to guide developers to write clear, readable Java code.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd
    Download as docx, pdf, or txt
    319 views4 pages

    Java Coding Standard

    Uploaded by

    Aileen Nicole Ayala
    This document provides a coding standard template for Java programs. It outlines guidelines for program structure and formatting, including using descriptive headers, comments, and indenting. Sections cover naming identifiers, capitalization, spacing, commenting code, and dividing code into logical major sections. The goal is to guide developers to write clear, readable Java code.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd
    Download as docx, pdf, or txt
    of 4

    Java Coding Standard Template

    Purpose

    To guide implementation of Java programs.

    Program Headers

    Begin all programs with a descriptive header.

    Header Format

    /**********************************************************************************/
    /* Program Name: the program name

    */

    /* Author:

    */

    /* Date:

    The date started developing the program

    /* Description: a short description of the program and what it does

    */
    */

    /*********************************************************************************/
    Listing Contents

    Provide a summary of the listing contents.

    Contents

    /**********************************************************************************/

    Example

    /* Listing Contents:
    /* Reuse instructions
    /* Includes:
    /* Import classes
    /* Class declaration:
    /*
    Global variables declarations
    /*
    Main method
    /*
    Constructors //optional
    /*
    Class methods

    */
    */
    */
    */
    */
    */
    */
    */
    */

    /**********************************************************************************/
    Reuse Instructions

    Describe how the program is used. Provide the declaration format, parameter
    values and types, and parameter limits.
    Provide warnings of illegal values, overflow conditions, or other conditions
    that could potentially result in improper operation.

    Reuse Example

    /**********************************************************************************/
    /*

    Reuse instructions

    */

    /*

    int PrintLine(char line_of_character)

    */

    /*

    Purpose: to print string, line_of_character, on one print line

    */

    /*

    Return 0 if printer not ready to print, else 1

    */

    /**********************************************************************************/
    Identifiers

    Use descriptive names for all variables, function names, constants, and other
    identifiers. Avoid abbreviations or single letter variables.

    Identifiers start with lower case.

    Multi-word identifiers are internally capitalized.

    Do not use hyphens or underscores to separate multi-word identifiers.

    Identifier Example

    private static float sumDiffSquares = 0; //this is good


    private static float x = 0; //this is bad

    (continued)

    Comments

    Document the code so that the reader can understand its operation.

    Comments should explain both the purpose and behavior of the code.

    Comment variable declarations to indicate their purpose.

    Good Comment

    If(record_count > limit) /* have all records been processed? */

    Bad Comment

    If(record_count > limit) /* check if record count exceeds limit */

    Major Sections

    Precede major program sections by a block comment that describes the


    processing that is done in the next section

    Example

    /*******************************************************************/
    /* The program section examines the contents of the

    */

    /* array grades and calculates the average class grade.

    */

    /*******************************************************************/
    Blank Spaces

    Write programs with sufficient spacing so they do not appear crowded.

    Use one blank space to separate classes and methods

    Indenting

    Indent two spaces at a time.


    Open braces (i.e. "{") do not start a new line.
    Close braces (i.e. "}") do start a new line, and are indented with the code they
    close.

    Indenting

    class Sample extends Object {

    Example

    int ivar1;
    int ivar2;
    Sample(int i, int j) {
    ivar1 = i;
    ivar2 = j;
    }
    int emptyMethod() {}
    ...
    }

    Capitalization

    Capitalized all defines.


    Lowercase all other identifiers and reserved words.
    Messages being output to the user can be mixed-case so as to make a clean
    user presentation.

    Capitalization
    Example

    public class MeanStd {}


    private static Vector vals = new Vector();
    private static Vector diffSquares = new Vector();

    Referencias

    Carnegie Mellon University. (2006). Assignment Kit for Coding Standard. SEI.
    Johnson, P. (1996). SourceFormatX. Recuperado el agosto de 2016, de Java Coding
    Standard: http://www.sourceformat.com/coding-standard-java-johnson.htm

    You might also like