Commenting:
For full credit on commenting, follow the guidelines specified for JavaDocs.
- Asterisks line up
- @tags at the bottom
- No space between closing comment marker and class/method signature.
Example:
/** * Description of program * * Assignment # * * @author * */ public class SomeClass { /** * Description of method * * @param * * @return * */ method signature { } }The minimum required are your Name and the Assignment Number (from the syllabus). If these two are not present, the program will be returned upgraded.
Indentation/Wrapping
Lines should never wrap when printed. Pay close attention to the lengths of your lines.
Symbols
The following symbols will appear on your homework:
->
->|
<-
<-|These symbols indicate that the lines need to be in/out-dented > add a blank line x unnecessary line