[Skip to Body]
Primary:
[Front Door]
[Current]
[Glance]
-
[Honesty]
[Links]
[Syllabus]
Groupings:
[EBoards]
[Examples]
[Exams]
[Handouts]
[Homework]
[Labs]
[Outlines]
[Readings]
[Reference]
Misc:
[SamR]
[Java 1.4.2 API]
[EIJ]
[CS152 2000F]
[CS153 2004S]
Back to Arrays. On to Project Discussion.
Held: Monday, 4 October 2004
Summary: Today we consider issues related to the documentation of programs We also consider javadoc, a special tool for generating documentation for Java.
Related Pages:
Due
Assignments
Notes:
Overview:
/opt/IBMJava2-142/bin/javadoc -author -version -tag pre:m:"Preconditions" -tag post:m:"Postconditions" package1 package2
@author
tag gives authors.
@version
tag gives the version.
@param name
tag describes parameters.
@exception type
tag describes exceptions.
@return
tag describes return values.
@pre
tag describes preconditions.
@post
tag describes postconditions.
Back to Arrays. On to Project Discussion.
[Skip to Body]
Primary:
[Front Door]
[Current]
[Glance]
-
[Honesty]
[Links]
[Syllabus]
Groupings:
[EBoards]
[Examples]
[Exams]
[Handouts]
[Homework]
[Labs]
[Outlines]
[Readings]
[Reference]
Misc:
[SamR]
[Java 1.4.2 API]
[EIJ]
[CS152 2000F]
[CS153 2004S]
Disclaimer:
I usually create these pages on the fly
, which means that I rarely
proofread them and they may contain bad grammar and incorrect details.
It also means that I tend to update them regularly (see the history for
more details). Feel free to contact me with any suggestions for changes.
This document was generated by
Siteweaver on Wed Dec 8 10:37:16 2004.
The source to the document was last modified on Thu Aug 26 20:22:23 2004.
This document may be found at http://www.cs.grinnell.edu/~rebelsky/Courses/CS152/2004F/Outlines/outline.22.html
.
You may wish to
validate this document's HTML
;
;
Check with Bobby