How do you comment effectively?

How do you comment effectively?

Focus on parts of the proposal that will affect you directly, or that you know about or have personal experience with.

1. Explain how you know what you’re talking about.
2. Give details and specific examples.
3. Provide data if you know about any, or at least identify the kinds of information that would be important to have.

How do you teach commenting skills?

The first teaching

1. Discuss what a comment is and what makes a good one.
2. Offer your own Sharing.
3. Explain what sorts of comments listeners might make.
4. Brainstorm comments with the class.
5. Do separate questions and comments.
6. Invite individual comments.

What makes a comment a comment?

If you comment on something, you give your opinion about it or you give an explanation for it. A comment is something that you say which expresses your opinion of something or which gives an explanation of it. He made his comments at a news conference in Amsterdam.

What is comment explain with example?

1. A comment is text in a program’s code, script, or another file that is not meant to be seen by the user running the program. Comments help make code easier to understand by explaining what is happening and help prevent portions of a program from executing. The image is an example of an HTML comment.

What should I write in comment?

Top ten tips for writing a great comment

1. Read the article.
2. Respond to the article.
3. Read the other comments.
4. Make it clear who you’re replying to.
5. Use the return key.
6. Avoid sarcasm.
7. Avoid unnecessary acronyms.
8. Use facts.

How do you write meaningful comments?

How to Write a Meaningful Comment

1. Use your own words to maximize impact.
2. Describe your connection to the place at stake (no matter where you live, you have one)
3. Identify what you think the agency’s decision should be, and why.
4. Draw from past experiences.
5. Read what the agency is proposing.

What is comment and example?

To comment is to make a statement, remark or express an opinion. An example of comment is when you share your opinion on an issue. The definition of a comment is a statement or remark. An example of a comment is a statement released in the paper that someone made about a scandal going on.

Is it comment or comment?

On webpages ( in contact-us forms and comment boxes ) plural and singular for of comment and comment/comments are variably used.

What do you call a comment in a code?

Code commenting is the practice of sprinkling short, normally single-line notes throughout your code. These notes are called comments. They explain how your program works, and your intentions behind it. Comments don’t have any effect on your program, but they are invaluable for people reading your code.

Which is the correct way to comment on a program?

There are usually two syntactic ways to comment. The first is called a single line comment and, as implied, only applies to a single line in the “source code” (the program). The second is called a Block comment and refers usually refers to a paragraph of text.

What’s the difference between block comment and single line comment?

The first is called a single line comment and, as implied, only applies to a single line in the “source code” (the program). The second is called a Block comment and refers usually refers to a paragraph of text. A block comment has a start symbol and an end symbol and everything between is ignored by the computer.

What does the comment above the function do?

The comment above the function explains what the function does – it checks if input is valid. The comment just saved you from bending over backwards trying to figure out what the function is doing.