standards

standards - COURSE PROGRAMMING AND DOCUMENTATION STANDARDS...

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

View Full Document Right Arrow Icon
COURSE PROGRAMMING AND DOCUMENTATION STANDARDS Programming Standards – how we expect you to approach the development of your solution. Includes our definitions of what are good programming practices and what we consider to be bad practices. Documentation Standards – what we want your code to look like when submitted. Please read and revisit this section carefully throughout the semester.
Background image of page 1

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

View Full DocumentRight Arrow Icon
Documentation, Programming, and Course Standards Grading Standards We will do our best to let you know the requirements of every assignment. However, because the problems solved in this class have no unique solution, it is not possible to list all criteria for each assignment as the unique approach that each effort will take may require a different set of criteria for assessing the quality of the effort and ultimately determining a grade. You will always be evaluated on the following aspects of your assignments: 1. Following provided assignment requirements . It is your responsibility to read the requirements thoroughly. 2. Developing the appropriate logic to solve the problem, accepting input in the order expected, and producing expected output . 3. Implementation of good programming practices in the final algorithm. Your program must be well- designed to promote easy modification and maintenance of the program. Your solution should be efficient to minimize wasting the limited resources of the computer. 4. Complying with course documentation standards . It is possible to receive less than full-credit for an assignment if each of the above is not followed to our expectations. Aspects of your submission other than producing correct output are important and can result in a loss of significant points on an assignment. Documentation Standards The reasons are numerous for requiring good documentation practices; the first is to make your code and logic as easy to understand and for your lab instructor to evaluate as possible. The solutions you are in the process of developing must be easily understood when seeking assistance. Poor documentation can make the role of a grader quite unpleasant. Another reason for documentation is to help you as a beginner to programming read code and to avoid introducing challenging errors into your program. Throughout this semester you will be presented code to interpret or modify and you will appreciate that there exists a standard for writing code that is easy to follow as you must quickly interpret an algorithm that you did not develop. The final reason for these standards is to help you develop good programming practices and to resist developing any bad programming habits. These standards are not merely recommendations they are required for the course and failure to comply will result in a loss of points. The course notes will attempt to abide by these standards as closely as possible to serve as an
Background image of page 2
Image of page 3
This is the end of the preview. Sign up to access the rest of the document.

Page1 / 10

standards - COURSE PROGRAMMING AND DOCUMENTATION STANDARDS...

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

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