It's UWAweek 48


This forum is provided to promote discussion amongst students enrolled in CITS2002 Systems 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.

Displaying selected article
Showing 1 of 919 articles.
Currently 5 other people reading this forum.

 UWA week 35 (2nd semester, week 6) ↓
SVG not supported

Login to reply

5:49am Sun 4th Sep, Christopher M.

> I also wanted to ask if this is how you would like us to comment our functions? > I looked up C guidelines online and this is what I found for commenting functions:
Similarly, consistency is more important, and the primary reason that many companies will have their own commenting conventions is to assist multiple programmers working on the same project/code, or even across multiple projects. But, notably (and as seen through a web-search) there's no simple agreement of what's the best, and the first version of a commenting convention is heavily influenced the first author's personal preference. There's also the thought that comments are rarely, if ever, needed if the identifier names are carefully chosen. (Personally) I don't like the large block comment in your example, and would just name the function square_of_larger_parameter(). And end-of-line comments // can add just as much value.

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  1:17AM Sep 14 2022
Privacy policy