Chapter 1 Style Requirements

Size: px

Start display at page:

Download "Chapter 1 Style Requirements"

Bernice Porter
6 years ago
Views:

1 Chapter 1 Style Requirements 1-1

2 Matters of Style Programming style can greatly enhance the readability of a program or it can detract from it and make a program confusing, difficult to read, debug and later modify. Style elements include the position of internal documentation, capitalization of identifiers, indentation and spacing. Spacing and indentation add to the visual organization of a program where capitalization gives a visual clue to a programmer as to what an identifier represents. We will use the following style requirements in CS 1A and CS 1B. YOU ARE RESPONSIBLE OR LEARNING HIS SYLE AND USING I IN ALL PROGRAMS URNED IN. REER O HIS SECION OEN. 1-2

3 1. Named constants will be in all caps. Basic Style Requirements Computer Science Department Saddleback College AX_RAE PROGRAMMER 2. Variables begin with a lower case letter and only the first letter of each successive word will be capitalized. hoursworked payrate grosspay 3. he declaration section shall contain one identifier per line along with the data type. int firstnum; int firstnum, int secondnum; secondnum, int thirdnum; thirdnum; 4. he declaration section must contain a data table stating the use of the variable or named constant and how its value is obtained/used. int firstnum; int secondnum; int thirdnum; float average; // first value to average - INPU // second value to average - INPU // third value to average INPU // average of three values CALC & OUPU int firstnum; // first value to average - INPU int secondnum; // second value to average - INPU int thirdnum; // third value to average INPU float average; // average of three values CALC & OUPU int firstnum; int secondnum; int thirdnum; float average; // input value // input value // input value // calculated average 1-3

4 5. Proper indentation is required SE HE AB SOP O 2 IN HE CODEWARRIOR EDIOR. cout << hello << endl; cout << hello << endl; cout << hello << endl; cout << hello << endl; 6. Document the executable code by section on the line ABOVE the code it references. he sections of the program are separated with blank lines. #include <iostream.h> void main(void) int num1; int num2; float average; // first value to average INPU // second value to average INPU // average of two values CALC & OUPU // get numbers to average from user cout << Enter first value to average: ; cin >> num1; cout << Enter second value to average: ; cin >> num2; // calculate the average average = float(num1 + num2) / 2; // output the average cout << \n\nhe average of the two numbers is << average; 1-4

5 #include <iostream.h> void main(void) int num1; // first value to average INPU int num2; // second value to average INPU float average; // average of two values CALC & OUPU // get numbers to average from user cout << Enter first value to average: ; cin >> num1; cout << Enter second value to average: ; cin >> num2; // calculate the average average = float(num1 + num2) / 2; // output the average cout << \n\nhe average of the two numbers is << average; #include <iostream.h> void main(void) int num1; // first value to average INPU int num2; // second value to average INPU float average; // average of two values CALC & OUPU cout << Enter first value to average: ; // read number from user cin >> num1; cout << Enter second value to average: ; // read number from user cin >> num2; average = float(num1 + num2) / 2; // calculate the average cout << \n\nhe average of the two numbers is << average; // output the average 7. Your program must begin with a description of what the program does. // his program calculates and outputs the average of two numbers. he two numbers are obtained // from the user of the program. #include <iostream.h> // Number average program #include <iostream.h> 1-5

6 8. Your program must contain your name, class section, title of homework assignment and due date. #include <iostream.h> void main(void) // declaration section here cout << Joe Programmer\n ; cout << CS 1B MW 10:30 Noon\n ; cout << Page #\4\n ;; cout << Due: 1/19/2000\n\n ; // documentation for next section here #include <iostream.h> void main(void) // declaration section here cout << Joe Programmer\n ; cout << CS 1B Homework Assignment\n\n ; // documentation for next section here 9. DO NO INIIALIZE VARIABLES IN HE DECLARAION SECION. Initialize variables just before their use in the program. int count; int count = 0; count = 0; 1-6

7 10. A block format shall be used for if and if/else statements. rench braces shall be used even for single statements. if (hours > 40) cout << Overtime pay is due ; if (hours > 40) cout << Overtime pay is due ; if (hours > 40) cout << Overtime pay is due ; LOWCHAR SYLE (if statement) statement statement 1-7

8 11. Use the block form of the if/else statement. he block format for the if/else requires the else to be placed on a line by itself. Note the indentation. rench braces line up with their corresponding if and else and the code contained in the braces is indented using a tab stop of 2. if (hours > 40) if(hours > 40) cout << Overtime is due ; cout << "Overtime is due"; else else cout << No overtime is due ; cout << "No overtime is due"; if(hours > 40) cout << "Overtime is due"; else cout << "No overtime is due"; 1-8

9 LOWCHAR SYLE (if/else statement) statement 2 statement 1 statement 1 statement 2 1-9

10 12. Nested if statements shall also use the block format. if (hours == 40) if (hours == 40) cout << ull time ; cout << ull time ; else else if (hours < 40) if (hours < 40) cout << Part time ; cout << Part time ; else else cout << Overtime due ; cout << Overtime due ; LOWCHARING SYLE (nested if) stmt 2 stmt 1 stmt 2 stmt

11 stmt 2 stmt 1 stmt 1 stmt 2 stmt 1 stmt 2 stmt

12 13. he switch statement shall be indented as follows. switch (maritalstatus) case M : cout << Married ; break; case S : cout << Single ; break; case D : cout << Divorced ; cout << Choose wisely next time ; break; default : cout << Invalid code ; break; switch (maritalstatus) case M : cout << Married ; break; case S : cout << Single ; break; case D : cout << Divorced ; cout << Choose wisely next time ; break; default : cout << Invalid code ; break; 1-12

13 LOWCHAR SYLE (switch statement) switch ression case label 1 case label 2 case label n statement statement statement switch. case label 1 statement case label 2 statement case label n statement 1-13

14 14. ormat for the while loop. cout << Enter a score: ; cout << Enter a score: ; cin >> score; cin >> score; while (score!= -999) while (score!= -999) scoreot += score; scoreot += score; scorecount ++; scorecount ++; cout << Enter a score: ; cout << Enter a score: ; cin >> score; cin >> score; cout << Enter a score: ; cin >> score; while (score!= -999) scoreot += score; scorecount ++; cout << Enter a score: ; cin >> score; 1-14

15 LOWCHAR SYLE (while loop) while ression while ression 1-15

16 15 ormat for the do.. while loop do do cin >> val; cin >> val; tot = tot + val; tot = tot + val; while (val!= -999); while (val!= -999); LOWCHARING SYLE (do..while loop) do do statement(s) statement(s) while while 1-16

17 16. ormat for the for loop for (int i = 1; i <= 10; i++) for (int i = 1; i <= 10; i++) cin >> val; cin >> val; tot = tot + val; tot = tot + val; LOWCHARING SYLE (for loop) for ression statement(s) NOE: he diamond is NO used for a counted loop. for ression statement(s) 1-17

18 17. Style requirements for user-defined functions. - he function name must begin with a capital letter (ex. GetVals, CalcCommission) - he function prototype must be fully documented (a description of what the function does, pre and post conditions, and documentation as to the data flow of the parameters). Examples: //*********************************************************************** // his function obtains three integer values from the keyboard and returns them to the // calling module. // // Preconditions: // n1, n2, and n3 are undefined // Postconditions: // n1, n2, and n3 have been read from the keyboard and returned // void GetVals( int& n1, // first integer read - OU int& n2, // second integer read - OU int& n3); // third integer read - OU //*********************************************************************** //*********************************************************************** // his function receives the current pay rate and a percent increase and returns a new rate // and amount of hourly rate increase. // // Preconditions: // payrt and perceninc are previously defined // payinc is undefined // Postconditions: // payrt has been reassigned to reflect new rate and returned // payinc has been calculated and returned // void CalcPayInc( float& payrt, // hourly pay rate - INOU float perceninc, // % of pay increase - IN float& payinc); // amount of hourly increase - OU //*********************************************************************** 1-18

19 //*********************************************************************** // his function receives two ages and returns the older of the two // // Preconditions: // age1 has been previously defined // age2 has been previously defined // the two ages are not equal // Postconditions: // he ages have been compared and the older of the two returned // int indolder( int age1, // first age to compare - IN int age2); // second age to compare - IN //*********************************************************************** NOE HE SPACING, INDENAION EC. O AVOID LOSING POINS, DOCUMEN YOUR PROOYPES AS DESCRIBED IN HIS SECION. PLEASE DO NO REPEA HIS DOCUMENAION IN HE DEINIIONS. 1-19

20 18. lowchart requirements for functions. Main: he flowchart for the main function shows the calls to the other functions. NOE: he names used in the calls must be the names of the variables (arguments) declared in the main. main GetAges(firstAge, secondage) olderage = indolder(firstage, secondage) output olderage end GetAges: he flowchart shows the logic for the input function. NOE: he only names that may appear in this flowchart are the names of formal parameters and locally declared variables and named constants. GetAges input age1, age2 end 1-20

21 indolder: he flowchart shows the logic for the selection function. NOE: he only names that may appear in this flowchart are the names of formal parameters and locally declared variables and named constants. Note also the use of a temp variable so there is only one return statement in the function. 1-21

Chapter 5 Style Requirements

Chapter 5 Style Requirements 5-1 Matters of Style Programming style can greatly enhance the readability of a program or it can detract from it and make a program confusing, difficult to read, debug and