C. Thomas Wu An Intro O-O Java Programming javadoc Utility

C. Thomas Wu An Intro O-O Java Programming Place these programs and their classes from the JavaDoc Folder onto the Desktop: Loan Calculator (Driver) Loan

C. Thomas Wu An Intro O-O Java Programming javadoc comments javadoc Utility provides documentation comments for every class, every method, every parameter, every return type, and every exception Benefits: Allows you to put your documentation together with your code When you update your program, can update your documentation at the same time Provides you with standardized online documentation capability

C. Thomas Wu An Intro O-O Java Programming Javadoc comments Javadoc comments begin with /** and end with */. Javadoc tags are special markers that begin For example: John Doe amount amount to withdraw a value of ‘String’ IOException if an error occurs

C. Thomas Wu An Intro O-O Java Programming Javadoc How to run the javadoc Utility From a command shell, invoke the javadoc utility with the command 1) javadoc MyClass.java Example: javadoc LoanCalculator.java Or javadoc *.java 2.) To display the document, open MyClass.html Example: LoanCalculator.html Note: The class must be public or protected

C. Thomas Wu An Intro O-O Java Programming Javadoc -How to run the javadoc Utility Using TextPad 1.Click Tools from the menu bar, Select the Run option 2. In the command text box, type: javadoc 3. In the Parameters text box, type MyClass.java Example: LoanCalculator.java 4. To display the document, open MyClass.html Example: LoanCalculator.html in the javadoc Folder folder on the M: drive