Assignment #1 up @ 9:15 A.M.
Print out PSP0 forms before starting Assignment #1 (even reading it).
Javadocs
Imports are always at top of file.
Put javadocs before classes/methods
Write javadoc on every public and protected entity
(entity means class, method, & field)
People want to know how to use the Method, not how it works
Methods have @param and @return, as well as @throws for exceptions thrown
Generate Javadocs does not recognize exceptions thrown
/*
_Description (summary of class)
@see (classreference)
@since (text)
@deprecated (text)- class or method that was originally part of program (no longer)
@author (text)
@version (text)
/
MethodJavadocs_
/Description
@see (class reference)
@since (text)
@deprecated (text)
@param (parameterName, description)
@return (description of return)
/
fields
Usually not documented
most fields will be private
private (all fields must be private unless...)
public (no field should be public except static,final, or is used in other classes)
protected (if needed by subclasses)
no modifier (means public, almost same as public)
/@see (classReference)
@since (text)
@deprecated (text)
/
Creating HTML javadocs
File->export->javadoc->choose destination folder->it will export as a webpage
Assignment #1 up @ 9:15 A.M. Print out PSP0 forms before starting Assignment #1 (even reading it).
Javadocs Imports are always at top of file. Put javadocs before classes/methods Write javadoc on every public and protected entity (entity means class, method, & field) People want to know how to use the Method, not how it works Methods have @param and @return, as well as @throws for exceptions thrown Generate Javadocs does not recognize exceptions thrown /* _Description (summary of class) @see (classreference) @since (text) @deprecated (text)- class or method that was originally part of program (no longer) @author (text) @version (text) / MethodJavadocs_ / Description @see (class reference) @since (text) @deprecated (text) @param (parameterName, description) @return (description of return) / fields Usually not documented most fields will be private private (all fields must be private unless...) public (no field should be public except static,final, or is used in other classes) protected (if needed by subclasses) no modifier (means public, almost same as public) / @see (classReference) @since (text) @deprecated (text) / Creating HTML javadocs File->export->javadoc->choose destination folder->it will export as a webpage