Task: Understanding and comment style documentation of some C program bits (423 lines with empty lines)
Subtask: Giving advices where the code seriously needs rewriting. No need for actual rewriting this time.
Length and deadline: Some hours work within some days.
Needed knowledge: C, some OpenCV, some image processing
BID with a very short sample work, please!
——————————————
You can bid without doing the sample work but in this case we won’t be able to judge whether your style suits our needs or not.
– Provide comments for example 1 in the attachment (getSubIm) to show your style.
– It’s 16 lines, but has just 9 lines which need comments.
– Use all the needed requirements below, please.
We NEED the followings:
———————–
– You’ll get 423 lines (containing empty lines too) from a C program (uses some OpenCV). As the main task you’re supposed to exemine the lines, understand them and prepare basic documentation in comment style. We need a detailed work here. See more on this below.
– As the subtask you’re supposed to understand where the code is seriously unefficient, has wrong programming style, or seems to be the first program lines of a student programmer. We DON’T need a very detailed work and we DON’t need code rewriting at this subtask, just some remarks where it’s necessary.
– You are supposed to provide your documentation, comments and remarks in proper English.
We DON’T NEED the followings:
—————————–
– No need for Word style documentation.
– No need for any code writing, but the programmer needs proper C knowledge.
We accept your work:
——————–
– If the code will become understandable by your comments for a C or for a not C programmer for the first glance.
– If you provide input, output and purpose explanation documentation per rutines in comment style.
– If you provide comments for used variables.
– If you provide basic comments for basic programming structures like for, if, etc. where they are used on a basic way.
– If you provide detailed comments for the more complex processes in a certain line or lines.
– If you provide some comments for the “out commented” lines. Possibly why they are there? Can they be useful in the future? If yes then what for?
– If you provide just ONE comment if e.g. 8 following lines do the same process e.g. on 8 images.
– If you place your comments above the explainde line/lines and not at the end of the line.
