Structure Comment Title For Free

Commenting involves placing Human Readable Descriptions inside of computer programs detailing what the Code is doing. Proper use of commenting can make code maintenance much easier, as well as helping make finding bugs faster. Further, commenting is very important when writing functions that other people will use.

Your comment header should include at least your name, course/section, date, and a brief description of the assignment. If the assignment asks you to submit multiple files, each file's comment header should describe that file/class and its main purpose in the program.

Top ten tips for writing a great comment Read the article. ... Respond to the article. ... Read the other comments. ... Make it clear who you're replying to. ... Use the return key. Avoid sarcasm. Avoid unnecessary acronyms. Use facts.

A good best practice to follow when writing comments in code is to describe the why, not the what. In general, good code should be self-explanatory in how it works, at least in isolation. Explain the reasoning behind the code, not just what the code is doing. This can help others understand the intent of the code.

In a comment, present your opinion, but give reasons (with reference to the text) ? if possible, refute counter arguments; start with your weakest argument and move on to the strongest argument. Paragraphs should end with a valid conclusion; in a comment, make a personal conclusion and restate your opinion.

If you are going to add commentary, state clearly what you liked about the post, or mention how the post has helped or enlightened you as a reader. If you have additional information, add it within the context of your comment. Have you tweeted the post? If so, mention it in your comment.

There are mainly two types of comments as follows: Line comment. Block comment.