TK Study

Software Engineering › Key terms › Y11 OOP › Code commenting

Code commenting

Term Y11 OOP

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 it is used in the test

Syllabus area: Y11 OOP.

Question types it can appear in

Where it has appeared in the paper

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

Related past questions

These are the questions the flashcard set links to this term. Open each one and compare your answer with its marking criteria.

Study links

How to use it in an answer

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.

Technique for the question types

Worked answers from the marking guidelines

Sample exam Q4 (1 mark): Collaboration (1 mark): 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

Common mistakes

Marker feedback on other questions of the same type (code and diagram feedback often applies across questions)
  • Python questions (2025 HSC exam Q19): process string inputs; use a selection structure; code must execute in the environment; use correct indentation; call functions in the main program after defining them.
  • Python questions (2025 HSC exam Q26): replicate the grid; use the random library; use selection and looping to access the list; include a method of checking the number of values; use meaningful variable names and constants; avoid overly complex structures such as nested IF loops.
General advice
  • Use the term exactly as the syllabus words it, then link it to the scenario in the question; the 2025 feedback repeatedly rewards using the stimulus.
  • Answer the command word: outline gives main points only, explain gives a reason or cause, discuss gives both sides.

Same group in the syllabus: Task definition · Facade pattern · Agility · Consistency (collaboration) · Version control · Feedback