It's UWAweek 18 (1st semester, week 9)

help2005

This forum is provided to promote discussion amongst students enrolled in CITS2005 Object Oriented Programming.

Please consider offering answers and suggestions to help other students! And if you fix a problem by following a suggestion here, it would be great if other interested students could see a short "Great, fixed it!"  followup message.

How do I ask a good question?
Displaying selected article
Showing 1 of 112 articles.
Currently 1 other person reading this forum.


 UWA week 17 (1st semester, week 8) ↓
SVG not supported

Login to reply

👍x1
helpful
4:06pm Mon 22nd Apr, Andrew G.

ANONYMOUS wrote:

The Style section of the rubric for the assessed lab says we need to use "comments to communicate intent and reason".

What sort of comments are required to obtain this mark, and do we need to include comments even if the code is self explanatory?

I tried to choose the wording "communicate intent and reason" carefully. It is not necessary to simply narrate what your code is doing, as the code already says that clearly. Your comments should explain why you have decided to do that.

Code that is "self-explanatory" typically only explains the steps it is performing, not the reasoning. Please make sure to explain your reasoning wherever a non-trivial decision has been made. The reader should not have to be solving a puzzle or guessing at your thought process as to why you wrote the code you did.

The University of Western Australia

Computer Science and Software Engineering

CRICOS Code: 00126G
Written by [email protected]
Powered by history
Feedback always welcome - it makes our software better!
Last modified  5:07AM Sep 06 2023
Privacy policy