Download presentation
Presentation is loading. Please wait.
Published byAbel Griffith Modified over 8 years ago
1
C. Thomas Wu An Intro O-O Java Programming javadoc Utility
2
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
3
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
4
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 with @. For example: –@author John Doe –@param amount amount to withdraw –@return a value of ‘String’ –@exception IOException if an error occurs
5
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
6
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
Similar presentations
© 2024 SlidePlayer.com. Inc.
All rights reserved.