Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
An assignment I’m working on asks for :
Reasonable inline code documentation, providing Javadoc generated documentation, with method descriptions, parameter and return value descriptions.
Isn’t that just /**? Or would it the eclipse generated version?
They are just asking for the code to be properly commented, in a way such that they can later extract the documentation via the
javadoctool. You should follow all the Javadoc best practices, and of course if you want extra credit, run the documentation phase of your build to actually generate the docs. I’m sure they will love that.