+ 1
I didn't understand documentation comment
10 Réponses
+ 7
Comments increase code readability and they help us when we need to change our code.
+ 4
Comments are ignored by the compiler/interpreter. They are there for increasing readability when programming in a team. Or to help you understand your own program if you get back to programming it after a long time.
+ 3
I hope S.C.'s answer solves your issue. Otherwise, would you please clarify your question?
+ 2
If you try to leave your code and don't read it for 2-3 month, you understand how much important are comment. In a team (as S.C. said) is very effective because everyone have different mode to program
+ 2
Yuri Biasi has given good explanation.
Imagine you are working in a company, on a project. But you are going on a vacation. So while you are out there, company puts a new guy on the project. Your comments and documentation will help the new guy understand the code. Also after you come back, the comments by the other guy will help you understand the changes made by him.
I hope that helps.
+ 1
Once when I learned that I also found it difficult because this one is different from other two comments (// and/* */).
Well coming to your query , I had tried to described documentation comment in simple words in comment section.
So if you wish you can read it.
Hope this helps ☺️☺️.
+ 1
rugved thank you
+ 1
Praveen, you can make sure the person gets notified when mentioning, by using @ character. Ex. Praveen
+ 1
0
ohh thank you very much! !