In my assignment, 10% of marks is awarded for the commenting of the code.
Are there special rules or regulations in java for commenting code?
I want to pick up as many marks as possible :cool:
Printable View
In my assignment, 10% of marks is awarded for the commenting of the code.
Are there special rules or regulations in java for commenting code?
I want to pick up as many marks as possible :cool:
See the following link
How to Write Doc Comments for the Javadoc Tool
Its a bit text heavy, but provides the standard practice for commenting classes, methods, etc...and when followed allows the javadoc tool to spit out API docs for your classes in the same style that Oracle provides for their libraries. Not sure if it talks about commenting in code, but complex portions of code within methods should be commented as well to let one know what it is you are doing
You can also check out the JLS chapter on comments: The Java Language Specification Documentation Comments