Can you have too many comments?
Table of Contents
- 1 Can you have too many comments?
- 2 What is the purpose of comments?
- 3 How many comments should you put in your code?
- 4 How do you comment like a pro?
- 5 How do you comment effectively?
- 6 Which scripting language uses the characters for comment text?
- 7 When should I add in-line comments to my code?
- 8 What is the difference between a single line and block comment?
- 9 Where should comments be placed in a program?
Can you have too many comments?
Too many times comments are just an excuse for writing bad code. If your code is not self explanatory, it is best to improve it and not use comments to describe it. Comments decay over time, which makes them wrong and misleading. They are true only when written, and even then they can’t be enforced efficiently.
What is the purpose of comments?
Comments are text notes added to the program to provide explanatory information about the source code. They are used in a programming language to document the program and remind programmers of what tricky things they just did with the code and also helps the later generation for understanding and maintenance of code.
How many comments should you put in your code?
A good goal is to have 1 comment for every 1-4 lines of code. Be sure to not only document what your code is doing, but, as you begin writing more advanced code, you should document what was intentionally left out, optimized away, tried and discarded, etc – basically, any design decision you make.
What is the main benefit of adding comments?
Commenting gives you feedback It shows that people have bothered to read your posts and appreciate them enough to have their say. Encourage your readers to comment on every post. The feedback they give you not only reassures you you’re writing what they want, they could also give you ideas for what to write next.
What language uses for comments?
End-of-Line Comments
| Language | Comment Syntax |
|---|---|
| Assembly Languages | ; (semicolon) |
| Ada, mySQL | — (two dashes) |
| C++/Java | // (two slashes) |
| FORTRAN 90 | ! (exclamation mark) |
How do you comment like a pro?
The basics tenets of commenting your code are simple:
- Make them brief.
- Keep them relevant.
- Use them liberally, but not to excess.
How do you comment effectively?
Effective comments are supported by factual information, sound reasoning, and/or include specific examples of how you or your organization would be impacted negatively or positively. When applicable, provide references to any reports, articles, or other source material that support your comment.
Which scripting language uses the characters for comment text?
An end-of-line comment terminates at the end of the line. A block line comment has a terminator and can continue for several lines, or be less than one line. Comments were called REMarks in BASIC. COBOL used a NOTE among other types of comments….Block Comments.
| Language | Comment Syntax |
|---|---|
| Haskell | {- -} |
How do you comment in English?
Structure and Content
- Introduction: defining the problem. Use the introduction to get the reader’s attention and interest in the topic.
- Opinion and Reasons. Give reasons for your opinion.
- Conclusion. Summarize the most important arguments that best support your opinion.
Is there anything wrong with comments in code?
There’s nothing wrong with comments per se. What’s wrong is writing code that needs those kind of comments, or assuming that it’s OK to write convoluted code as long as you explain it friendly in plain English. Comments don’t update themselves automatically when you change the code.
When should I add in-line comments to my code?
You should add “in-line” comments wherever you think a little bit of English explanation would be useful to either yourself or someone else (like a TA) who is going to read your code. Such in-line comments should be used whenever the code is not “transparent” (easy to follow simply from the names of the variables).
What is the difference between a single line and block 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.
Where should comments be placed in a program?
Comments should occur in the following places: The top of any program file. This is called the “Header Comment”. Above every function. This is called the function header and provides information about the purpose of this “sub-component” of the program. In line.
https://www.youtube.com/watch?v=7TU9QllN0Ws