Computer Programming I and II Instructor: GregShawCOP 2210 and 3337 Using the javadoc Utility in NetBeansThe javadoc utility program is used to generate HTML "help" pages forjava files that have been properly documented with Java documentationcomments. (See "Java Documentation Comments" online). These web pages will have the same format as the official Java LanguageDocumentation.I. Generating HTML “Help” Pages for Your Java Files- To create help pages for all java files in a project, just openthe project and choose “Generate Javadoc (project-name)” from theRun menu (or right-click on the project icon in the Projectspane and choose “Generate Javadoc” from the popup menu)Note: Due to a bug in Netbeans, this currently will not work forprojects stored on our network. However, it will work fine onyour own machine or – if working in our labs – for projectsstored on a flash drive- This will create many files, all stored in a folder namedjavadoc, located in the dist folder in your project folder - The documentation for each Java file will be a file with the samename but with an extension of html. E.g. the documentation filefor Hello.java would be Hello.html Each class must reside in a separate file, and be designated aspublic As of version 7.0, NetBeans will no longer generate javadoc forclasses in the default package (i.e. the src folder). Tolearn how to create and use your own packages, see the“ Packages ” document, online II. Viewing the Web Pages in NetBeansTo open the HTML file in your default browser from NetBeans:- In the Files pane, right-click on the icon for the .html file andchoose View, or - In the Source Editor window, right-click on the class name andchoose Show Javadoc To view the HTML file outside of NetBeans, use your browser’sFile menu to open the file, or navigate to find the file andthen double-click the file
View Full Document
Unlocking...