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
Welcome to the Java Programming Forums
The professional, friendly Java community. 21,500 members and growing!
The Java Programming Forums are a community of Java programmers from all around the World. Our members have a wide range of skills and they all have one thing in common: A passion to learn and code Java. We invite beginner Java programmers right through to Java professionals to post here and share your knowledge. Become a part of the community, help others, expand your knowledge of Java and enjoy talking with like minded people. Registration is quick and best of all free. We look forward to meeting you.
>> REGISTER NOW TO START POSTING
Members have full access to the forums. Advertisements are removed for registered users.
LinkBack URL
About LinkBacks
Commenting in Java
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
Related threads:
Re: Commenting in Java
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
Re: Commenting in Java
You can also check out the JLS chapter on comments: The Java Language Specification Documentation Comments
Useful links: How to Ask Questions the Smart Way | Use Code Tags | Java Tutorials
Static Void Games - Play indie games, learn from game tutorials and source code, upload your own games!
Reply With Quote