##About Comments in general
About Comments in general
##About Comments in general
About Comments in general
- 2k
- 1
- 11
- 20
- youYou have not commented enough.
- youYou have commented all the wrong things.
- youYou have commented too much.
- yourYour comments are in the wrong format.
- youYou are missing the formal comments.
letLet me say that again.:
Good code seldom needs comments.
- commentsComments make plain what the code does not tell us already.
- goodGood code seldom needs comments.
- goodGood code seldom needs comments.
- goodGood code must make plain what the code does without the need for additional explanation.
- you have not commented enough
- you have commented all the wrong things
- you have commented too much.
- your comments are in the wrong format
- you are missing the formal comments.
let me say that again.
Good code seldom needs comments
- comments make plain what the code does not tell us already
- good code seldom needs comments
- good code seldom needs comments
- good code must make plain what the code does without the need for additional explanation.
- You have not commented enough.
- You have commented all the wrong things.
- You have commented too much.
- Your comments are in the wrong format.
- You are missing the formal comments.
Let me say that again:
Good code seldom needs comments.
- Comments make plain what the code does not tell us already.
- Good code seldom needs comments.
- Good code seldom needs comments.
- Good code must make plain what the code does without the need for additional explanation.
Bottom line, though, is that the comments in your code should fill in the blanks that your code does not. In addition, your comments should give details on the motivation, and not the application of your code. You should, ingeneralin general, comment only on why your code does things, not what your code is doing.
You have no JavaDoc, and you likelyelikely should. JavaDoc is where you describe what your code does, because, typically, the people reading the javadoc are not reading the code, so they need something else to tell them what the code does.
Bottom line, though, is that the comments in your code should fill in the blanks that your code does not. In addition, your comments should give details on the motivation, and not the application of your code. You should, ingeneral, comment only on why your code does things, not what your code is doing.
You have no JavaDoc, and you likelye should. JavaDoc is where you describe what your code does, because, typically, the people reading the javadoc are not reading the code, so they need something else to tell them what the code does.
Bottom line, though, is that the comments in your code should fill in the blanks that your code does not. In addition, your comments should give details on the motivation, and not the application of your code. You should, in general, comment only on why your code does things, not what your code is doing.
You have no JavaDoc, and you likely should. JavaDoc is where you describe what your code does, because, typically, the people reading the javadoc are not reading the code, so they need something else to tell them what the code does.