3.2.5 - Writing Maintainable Programs

Key Terms
1. Variable
  1. Name associated with a particular memory location used to store data.
  2. By using the variable name, the programmer can:
    1. Store data
    2. Retrieve data
    3. Manipulate data
  3. The value of the data is not know when the program is written.
  4. Scope
    1. Local variable
      1. Declared and used inside:
        Modules
        Functions
        Procedures
        Subroutines
      2. Only available inside their specified module, procedure etc...
      3. Created when the subroutine is called.
      4. Destroyed when the subroutine exits.
    2. Global variable
      1. Declared at the beginning of the code.
      2. Available throughout the code.
  5. Can change while the program is running.
2. Constant
  1. A data item with a fixed value.
  2. Assigned to a variable that cannot be changed when the program is executed.
3. Identifier
  1. A name representing an object within a program.
    1. Variables
    2. Functions
    3. Procedures
    4. Data Types
  2. Given meaningful names.
4. Reserved Word / Keyword
  1. Vocabulary of a programming language.
  2. Variables or other identifiers cannot use keywords.
  3. Can only have the meaning which is defined in the language.
Coding Practices
1. Modularisation
  1. Series of small routines.
  2. Can quickly be seen to be performing one function.
  3. Complex operations should be broken up into subroutines.
    1. Defined separately and called from the main program.
  4. Easier way to achieve if the program has been designed using top-down techniques.
2. Commenting Code
  1. Comments are read by the programmer and ignored by the computer.
  2. Should be written while the code is written and not after.
  3. Comments should be used for:
    1. Program headers
    2. Subroutines
    3. Declaring variables
    4. Inline comments
3. Indentation
  1. Improves readability.

Next up

3.2.5 - Writing Maintainable Programs

Description

Resource summary

Similar

	Created by AndrewZV over 10 years ago