Code commenting

Term

Jump to a topic

See every item in the sequence

Definition

Short explanations in the code that say what it does and why, so other developers and your future self can understand and maintain it.

Example: # calculate GST for each item

Found in: syllabus.

Where you'll use it in the test

Syllabus area: Y11 OOP.

Question types it can appear in

Multiple choice: Pick the option that matches the definition or example.
Multi-select: You tick every correct option, so know all its features or goals.
Short answer: Define, outline or explain it and tie it to the scenario.
Python: Write or complete it in the online Python tool.

Where it has appeared in the paper

The Software Engineering Project (Part B). Part letters follow each paper’s own layout.

How to use it

A model sentence

General advice, built from the definition and example above

“Short explanations in the code that say what it does and why, so other developers and your future self can understand and maintain it.” Then apply it: # calculate GST for each item

In a short answer, give the definition in your own words first, then tie it to the situation in the question. Do not copy the example above unless it fits the scenario.

Command words used with it

General advice

No linked question shows the command word for this term. Across the past short answer and python questions in this bank the words used most are: Explain, Outline, Describe, Compare, Classify, Analyse. Check the actual word in your question.

Official worked answer

Sample exam Q4 (1 mark): Collaboration (1 mark): official criteria and sample answer

Criteria

1: Correctly identifies the benefits.

Sample answer

Different points of view can be considered. Tasks can be delegated to those with expertise.

Open the question page

Go deeper

Flashcard: Code commenting in The Object-Oriented Paradigm (Year 11) · study that set
Memorise: Object-oriented concepts
Notes: Object-oriented concepts (Year 11 content (Programming fundamentals, OOP, Mechatronics))
Full term page: every question, note and marking comment for Code commenting

Check yourself

Explain “Code commenting” in one sentence, give an example, and name a question type that could test it.

Reveal the answer