0

I dont understand the use of documentation comments...can anyone help?

22nd Nov 2019, 10:51 AM
Nihaaraa Dilras Habib
Nihaaraa Dilras Habib - avatar
5 Answers
+ 3
Nihaaraa Dilras Habib You can document information and read it with help function. Run this: def f(): """ Does nothing. """ help(f)
22nd Nov 2019, 11:28 AM
Seb TheS
Seb TheS - avatar
+ 1
I mean what is used for?
22nd Nov 2019, 11:21 AM
Nihaaraa Dilras Habib
Nihaaraa Dilras Habib - avatar
+ 1
1) //adding to numbers int a=b+c; 2) /*function for Array sorting descending order*/ int sortArrayd() { .... } Read comments what it saying.. It is your defined, so you or other can understand clearly what you are doing by that code, without examining total for later purpose... Its optional for your simple analysis.. So simply understanding purpose 3) documentation comments are used to create documentation API. for that you need use javadoc tool. ex: /** Array class provides accending sort, descending sort, print methods*/
22nd Nov 2019, 11:35 AM
Jayakrishna 🇮🇳
Jayakrishna 🇮🇳 - avatar
0
Documentation comments be like this, /** * @parameter * hello */ That's all
22nd Nov 2019, 11:12 AM
VOID
VOID - avatar
0
Thank you all for helping me out
22nd Nov 2019, 12:14 PM
Nihaaraa Dilras Habib
Nihaaraa Dilras Habib - avatar