Developing Software: Introduction CSE 1502
array
a collection of elements where each element can be selected by identifying keys at run-time
program code listing
a direct copy of the executable program code, including all comments
internal documentation revision history
a record of the parts of the program being worked on and possibly other info
internal documentation prefacing
a short explanatory comment at the start of major components of a program
zzzzz :-) gross pay
all lower case, grosspay, mix upper and lower, GrossPay, use separator, Gross_Pay, camel casing, grossPay
the four aspects of good coding practice
apply meaningful names, code maintainability, internal documentation, technical guide
specification document introduction
basically a revised version of the project brief
the two test methods
black box testing, white box testing
entrance-controlled condition-controlled loop
body of loop will only be executed if entry condition is satisfied
how do you apply meaningful variable names?
choose and stick with a naming standard
the three types of loop
condition-controlled, count-controlled, for
internal documentation comment driven development (CDD)
copying the algorithms for parts of the program and translating pseudo-code into program code
character data type
data is enclosed in quotation marks
specification document information description
describes how the data is organized within the system
specification document functional description
describes the functions and design constraints of the system
black box testing
does not take the structure of the program into account
the two types of condition-controlled loop
entrance-controlled, exit-controlled
design document
explains the architectural design of the program, especially its functional decomposition
test plan
explains what tests are to be carried out and the expected results
test log
explains whether the tests were successful or not and the actual results
what is black box testing sometimes called?
functional testing
the two types of numeric data type
integer, real
the three parts of the specification document
introduction, information description, functional description
the five common tips for internal documentation
keep short and simple, do not overuse, use to explain code, use to eliminate code while testing, do not use for redundant code
count-controlled loop
loop will continue for a fixed number of times
for loop
loop will continue until control variable has passed its final value
exit-controlled condition-controlled loop
looping continues until exit condition is satisfied
the four common variable naming standards
lower case, upper and lower case, camel case, use of separator
the three general standards of code maintainability
make sure the data section is well commented, make sure the function section is well organised, make sure functions have reference details
internal documentation tagging
making sure that sections of code in brackets, quotation marks, etc. are closed
the three data types
numeric, character, logical
the four types of internal documentation
prefacing, comment-driven development (CDD), revision history, tagging
the five parts of the technical guide
project brief, specification document, design document, program code listing, test documentation
the three programming structures
sequence, selection, iteration,
the two types of character data type
single character, character string
single character character data type
stores any single character except a quotation mark
real numeric data type
stores numbers with fractional parts
logical data type
stores only the values 'true' (on) and 'false' (off)
integer numeric data type
stores positive and negative whole numbers
character string character data type
stores strings of any characters except quotation marks
what is white box testing sometimes called?
structural testing
white box testing
takes the structure of the program into account
the two parts of the test documentation
test plan, test log
what is the logical data type also known as?
the boolean data type
architectural design
the overall organization of a program
zzzzz :-) glacier
to be human readable and easy to understand at a glace
how do you apply meaningful function names?
use a verb/noun combination
zzzzz :-) meat pie
use verb/noun combinations eg calculate_netpay( ), gross_pay=hours_worked*hourly_rate
functional decomposition
when a program is split into smaller sub-problems which can be handled separately by sub-programs
sequence
when instructions are carried out one after another
selection
when instructions are chosen by a value in a condition
iteration
when instructions are repeated any number of times
project brief
written by the client to roughly explain what he wants the program to do