+ 1

Define documentation comment simpler way

needed more explanation about how documentation comment works

13th Mar 2018, 3:43 PM
Harish Vellala
Harish Vellala - avatar
4 Respostas
0
Well, it depends what programming language and maybe the IDE you’re using, but documentation comments will describe the purpose of a method and the arguments of the method. If you hover over a function created by (I’m using Java and eclipse for this example) Java, you’ll see a yellow box pop up and describe the method. Documentation comments allow you to do this.
13th Mar 2018, 4:03 PM
Ariela
Ariela - avatar
+ 2
Generally, documentation comments are used by documenting tools, these tools generate software documentation, for example in the documentation about method X, everything related to method X will be documented, its return value type, each of its parameters and their types, where in the project method X is declared and so on, something like that...
13th Mar 2018, 4:07 PM
Ipang
0
Basically comments are for the programmer. They make the code easier to read for you or someone else looking at the code
13th Mar 2018, 3:56 PM
Ariela
Ariela - avatar
0
but why documentation comment. what is so special about it. can you explain little deeper
13th Mar 2018, 3:57 PM
Harish Vellala
Harish Vellala - avatar