I didn't understand documentation comment | Sololearn: Learn to code for FREE!
New course! Every coder should learn Generative AI!
Try a free lesson
+ 1

I didn't understand documentation comment

17th Jul 2018, 12:34 PM
Praveen
10 Answers
+ 7
Comments increase code readability and they help us when we need to change our code.
17th Jul 2018, 1:31 PM
Muhd Khairul Amirin
Muhd Khairul Amirin - avatar
+ 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.
17th Jul 2018, 12:37 PM
Satyam
+ 3
I hope S.C.'s answer solves your issue. Otherwise, would you please clarify your question?
17th Jul 2018, 12:42 PM
cyk
cyk - avatar
+ 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
17th Jul 2018, 12:45 PM
Yuri Biasi
Yuri Biasi - avatar
+ 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.
18th Jul 2018, 2:52 PM
Rugved Modak
Rugved Modak - avatar
+ 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 ☺️☺️.
17th Jul 2018, 1:48 PM
Meet Mehta
Meet Mehta - avatar
+ 1
rugved thank you
18th Jul 2018, 2:56 PM
Praveen
+ 1
Praveen, you can make sure the person gets notified when mentioning, by using @ character. Ex. Praveen
18th Jul 2018, 3:29 PM
Rugved Modak
Rugved Modak - avatar
18th Jul 2018, 3:29 PM
Satyam
0
ohh thank you very much! !
18th Jul 2018, 2:55 PM
Praveen