0

Documentation comnents

What are documentation comments and what are they used for

23rd Jun 2017, 3:57 PM
Taiwo Seun
Taiwo Seun - avatar
2 Answers
+ 4
In Java they are enclosed in /** */ These are mostly use to describe different components of a solution or to create how to do help. Using javadoc utility, using these comments HTML page is generated.
23rd Jun 2017, 5:16 PM
देवेंद्र महाजन (Devender)
देवेंद्र महाजन (Devender) - avatar
+ 4
documentation comments are defined with xml tags and give your code fully and structured explanation to users. when you call a function you see a summary of function and it's parameters. for example for c#: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments
23rd Jun 2017, 7:30 PM
Saeede
Saeede - avatar