Professional Code Practices training course

1. Course introduction

2. Introduction to Professional code development standards

Why is some code bad?
Benefits of code standards
Quality code
Practical – given an existing piece of JavaScript code, work out what it does

3. Naming standards

Industry standards
Best practice naming standards
What to apply naming standards to
Practical – using the code you were given previously, create (and code) good naming standards for all applicable areas of the code.  Swap your code with the next team, review and critique their work.

4. Formatting and building for readability

Prettifying code
Structure, why it matters
Repetition, the DRY principle
Function size and structure
Parameters
Practical – Using the last code you used (from the other team) redesign the code to use better format and function style.  Swap your code with the next team, review and critique their work.

5. Comment style

Benefits of commenting
Comment style
What to comment
Practical – Using the last code you used (from the other team) add any comments you feel are necessary.  Swap your code with the next team, review and critique their work.

6. Approaches to programming– Imperative, declarative

Explanation of different approaches
Benefits and drawbacks of each style
Examples of the same code written in the two different styles

7. Programming paradigms good practice – OOP, Functional, Procedural

Explanation of different paradigms
Good style for each paradigm
Examination of example code written in the different styles
Good practice for Class and object design - inheritance, encapsulation, abstraction, polymorphism
Practical – Using the last code you used (from the other team) design and build suitable object classes.  Swap your code with the next team, review and critique their work.

8. S/W development patterns

Programming patterns introduction
Pro’s and con’s of patterns
Example JavaScript patterns
Practical – Using the last code you used (from the other team) rewrite the code so it uses the Memoisation pattern.  Swap your code with the next team, review and critique their work.

9. Robust code – error handling and other techniques

Don’t trust data
Write error handling first
Return values from functions
Fail not fall
Good error messages
Practical – Using the last code you used (from the other team) add any error handling you feel is necessary.  Swap your code with the next team, review and critique their work.

10. Code smells

General code smells
JavaScript specific code smells
Practical – Using the last code you used (from the other team) review and critique the code to see if you can identify any remaining code smells.

11. A consideration of testing effectiveness

TDD
Unit testing
What to test
When to test
CAST
Practical – Using the last code you used (from the other team) plan and develop suitable tests.  Swap your code with the next team, review and critique their work.