Code #

• 1. Introduction
• Level Specific Guidance
  • Level 4
    • Code Commenting
    • Code Review
  • Level 5
    • Code Commenting
    • Code Review
  • Level 6
    • Code Commenting
    • Code Review

1. Introduction#

The code step concerns the implementation of the structures modeled in the design phase. This phase is where development begins, and probably the main reason why you are on this course. Tutorials on how to code e.g. syntax of languages is not greatly covered in here, instead, good coding practices, good code comments, and how to do good code reviews are outlined and explained.

For guidance on coding standards on some languages you will likely encounter on the course (which should be adhered to in your projects as much as possible), visit either:

• C#/C++ Coding Standards
• Java Coding Standards
• JavaScript Coding Standards (An example from AirBnb)
• Python Coding Standards
• PHP Coding Standards

Level Specific Guidance#

Level 4#

At level 4, your code should have comments that help you understand the code you've written. The comments should also help anyone else who consume your code but likely won't read through it in any depth. You're expected to work through manual code review techniques.

Code Commenting#

Code Review#

Level 5#

Your code comments should now help keep your code maintainable by following a consistent standard. You might consider automating your style checks to ensure consistency.

Code Commenting#

Code Review#

Level 6#

In your final year, you're expected to build on previous levels by also documenting the APIs you create.

Code Commenting#

• Should follow proper coding standards. Need to be consistent with design. Code should be properly documented and should have generated documentation like API doc (e.g., swagger) or Javadoc.
• A tool should be used, code coverage would be nice.

Code Review#