Wednesday, October 15, 2008

Portfolio 4 - Writing Problems in Engineering Classes

Engineering has truly changed its face in many areas. One of which is in communication. Engineers are not just spending their whole day doing projects like what many people still perceive. They are also required to communicate effectively in order to present their working. This is one of the reasons why many engineering courses demand the future engineers to possess sufficient language skill. The courses in NUS are no exception.

My programming lesson (CS1101C), for example, requires the students to give title, purpose of the program, as well as the comments in different parts of the programs we develop. It is actually very helpful to do these things to improve the readability of the programs. So, programs are not only containing codes, symbols, or variables, but also words to describe the programs.

Of course the words we put in programs are not in the form of essay, nor paragraph. Usually, only about one or two sentences are needed. However, it is still not an easy thing. The problem is not about accuracy, but efficiency. Our main purpose are not just making the program work correctly, but also make it looks more compact without leaving the core idea behind.

It is important to know technical term in order to help us make the comments look simpler. For example, rather than saying, “add the value of x by 1”, it is nicer to say, “increment x by 1”. The way to overcome this problem is clearly by learning more terms. As the complexity of programs increases, more terms will be needed to describe different types of programs. Since most of the programs are aimed for engineering problem solving, so it is the right opportunity to improve my language skills in terms of engineering problems as well.

6 comments:

Unknown said...
This comment has been removed by the author.
Unknown said...

Unavoidably in CS1101C we need to put in short comments. Comments are for us, as programmers, to understand what we have written after a period of time. Besides, comments are to be short, simple but concise, as long comments are just reducing the readability. Therefore, we need to enhance our vocabulary on technical terms in order to do that.

yohan said...

Ooops,,
I mistakenly deleted the first comment...
To the one who posted it, please don't feel offended, it was 100% unintentional.
If you please, feel free to post it again. I have not even read a single word of it.
Sorry for the trouble...

Steven Li said...

Haha, you are lucky that you do not have MLE1101 in this semester. However, the comments in programs are indeed a challenging task. It is because that you must use brief and short sentences to explain your idea. Every programmer can have their own idea about how to write comments in program. There is no standard solution because the compiler will ignore all the comments. So our goal is to use the minimized languages to let others understand our program. So I think this is the difficult point for commenting in the programs.

Nguyen Sy Nguyen said...

Comments will explain the algorithm the programmer used to reader. Also, sometimes, they will show the programmer their own mistakes. So, clear and brief comments are needed in the code of the program.

TONG YU said...

making comments in programmes is not an easy work.comments should be understandable, short. to make the comments readable, we need to be abla to use a large amount of technical words.