Welcome to the CSC Q&A, on our server named in honor of Ada Lovelace. Write great code! Get help and give help!
It is our choices... that show what we truly are, far more than our abilities.


+15 votes
asked in CSC305 Fall 2022 by (1 point)

2 Answers

+7 votes

Yes, you should put Javadoc comments above all your non-private methods, explaining what the method does, what the parameters are, and what value gets returned. For a void method, there's no value returned so you can leave out the @returns part.

answered by (508 points)
+7 votes

For methods you want to add java docs, put /** at the top of your method. It will generate a parameter and/or return types for you, based on your method.

answered by (1 point)