Coding Standards

Coding Standards - CS180JavaProgrammingStandards

Info iconThis preview shows pages 1–2. Sign up to view the full content.

View Full Document Right Arrow Icon
The following standards are to be followed in writing Java programs. They are important  enough to be part of the grading criteria for all programs. Any constructs not covered in  this standard are to be implemented in a consistent and readable fashion. PURPOSE The purpose of these rules are (1) to introduce you to a representative set of coding  standards that are typical in professional programming and (2) to help you develop good  style as a habit, something you will find necessary to successfully complete large  programs. There is no doubt that you can write Java programs to solve the small  problems in this course without attention to style. But, you must keep in mind that you  are building professional skills, not merely finding the answers to problems handed out  as exercises. FILE NAMES AND JAVA COMPILER In this course each Java file name should clearly represent what it is and each should  have the ``.java'' suffix. Files names must match the class name. For example, Project 1  should be Project1.java. A lab project that determines the payroll of a small company  could be Payroll.java (or even something like Lab3.java).  INTRODUCTORY DOCUMENTATION At the beginning of each Java class there should be a JavaDoc block that contains:  1. The program name, your name, and recitation section. 2. A brief description of the program that describes the method or algorithm used to  obtain the solution, the major data structures (if any) in the program, and other  general comments including extra features. 3. The date the program was completed. The format to be used is as follows: 
Background image of page 1

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Image of page 2
This is the end of the preview. Sign up to access the rest of the document.

This note was uploaded on 02/19/2012 for the course CS 180 taught by Professor Staff during the Spring '08 term at Purdue.

Page1 / 6

Coding Standards - CS180JavaProgrammingStandards

This preview shows document pages 1 - 2. Sign up to view the full document.

View Full Document Right Arrow Icon
Ask a homework question - tutors are online