help3007

It's UWAweek 47

help3007

This forum is provided to promote discussion amongst students enrolled in CITS3007 Secure Coding. If posting a question, it's suggested you check first whether your question is answered in the unit Frequently Asked Questions (FAQ) list, and use the search box (on the right) to see if an answer to your question has already been posted.

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.

Note that any posts must comply with the UWA Code of Conduct and the UWA Academic Conduct Policy. That means you should (a) treat everyone with respect and courtesy, and (b) not post your solutions to an assessment that's in progress.

If asking a programming question, it's recommended you read How do I ask a good question? If reporting or troubleshooting a bug in software used in the unit, it's recommend you read How to report bugs effectively.

Displaying selected article

Showing 1 of 170 articles.
Currently 28 other people reading this forum.

UWA week 21 (1st semester, week 12) ↓

Helper functions in the project? (all 4)

10:11am Wed 22nd May, Arran S.

Hi,

The cli function is the only one you're required to write a Doxygen-processable documentation block for. API documentation is essential for any public-facing function, and cli is one of those.

For helper functions: even though these are internal, it's still good practice to give any function at least some sort of comment explaining what it does - you'll need to make a judgement call about how much detail is warranted. e.g. For very simple functions, maybe a line or two is enough.

Does that clarify things?

Cheers

Arran

ANONYMOUS wrote:

The project brief mentions

'you may also write whatever “helper functions” you wish.'

I was wondering if we were required to write up Doxygen-processable comments for these helper functions or if it is only needed for the cli function.

help3007 articles all ANNOUNCEMENTS recent articles login to post a new article tagged articles (144 / 199) the unit in general (6) software security in the news (1) lectures (5) labs (22) project (78) final exam (17) tests and quizzes (9) trivia (3) the C language (3) help3007 topics from today and yesterday from the past week from the past two weeks ALL topics, most recent first	login chapter0 unitinfo research projects csforum csse-feedback csbreakdown cssubmit csmarks 2nd semester help fora Algebra Advanced Algorithms Cloud Computing High Performance Computing Intelligent Agents Professional Computing Relational Database Management Systems Systems Programming