ado| creation Although the detailed design in software engineering is an important stage of software project, it is often not implemented in practice. Not this stage is not important, but the implementation of a great deal of difficulty, because the software requirements are born with ADHD patients, finally detailed design, the demand has been different from the original version, and the cost of a huge, fine carved detailed design has become yesterday's yellow. On the other hand, some functional implementations often have to wait until the real code to think of a better method, after all, design is "out of thin air", and coding is "practice", so in the code when the original design adjustment is often unavoidable.
The detailed design document is a description of the source code implementation, but it is physically separated from the source code file, and the consistency between the two is easily broken, and the cost of maintaining both consistency is often unbearable for the normal cycle of the project. Various "from the document" or "direct document" technology came into being, Javadoc is the Java document technology, that is, through the "parasitic" in the source code file annotation information generated help documents, this help document itself is a detailed design document. Because the program code and the annotation information are in the same file, it is easy to adjust the annotation when changing the program, and the consistency between the two can be easily ensured.
As a Java programmer, you must have seen the JDK API help documentation, JBuilder's JDK1.4 help documentation is located in the <jbuilder installation directory >/doc/jdk_ Docs.jar, which contains the JDK's Javadoc documentation, you can extract the Jdk_doc.jar to a directory with uncompressed software such as WinRAR, and the documentation in the JDK_DOCS/JAVA/API directory is the JDK documentation for your document. Double-click the index.html file in the Open directory and you will see the following page
Figure 1 Javadoc documentation for JDK |
The page is divided into three frames, the upper-left frame is the list of packages, the lower-left frame is the list of classes in the package, and the right main window frame is the API description page for the class.
Class API Description The top of the page has a navigation bar to facilitate links to a number of commonly used pages, these common pages include:
· Overview: A description List of all packages, one row in each package corresponding table.
· Package: A description List of all classes or interfaces in a package, one row in each class or interface table.
· Class: Marked as current class with no links on it.
· Use: all associated classes of a class: including inheritance relationships, dependencies, association relationships, and so on.
· Tree: In the hierarchy to list the class-level relationship in the package, through this list, you can trace the origin of the class, the following is the Java.applet package applet class inheritance with implementation trees.
Figure 2 listing the classes in the package in a hierarchy |
· Deprecated: All outdated classes, interfaces, range, methods, constructors.
· Index: Indexing page, which indexes all classes, interfaces, constants, and methods in the JDK, so that you can quickly navigate to the Help content you want, and the page is as follows:
Figure 3 Organizing in an indexed way |
· Help: For information on how to use the Javadoc documentation, you can learn more about using Javadoc in this document.
Each class and interface corresponds to a Javadoc document, with the highest proportion of Javadoc documentation for classes and interfaces and the richest content, which is a direct reference document that uses these classes and interfaces. Since the analogy interface contains more content, we only cover the documentation for the class. A typical class Javadoc document includes the following:
• Navigation bar: In the document head and tail have a navigation bar, easy to quickly link to the commonly used pages, provides a link to the previous page and the next page, and provides a positioning to the different parts of this page anchor chain connection.
• Class inheritance: The Inheritance tree of classes, the interfaces implemented by classes, and subclasses of classes. This information allows you to understand the association relationships of classes vertically.
• Brief description of class: A brief description of the class, describing the function of the class.
• List of internal classes: Lists the inner classes defined in the class.
• Class-Domain Summary: All protected and public ranges, each of which corresponds to a sentence description.
• Class-Constructed method summary: All protected and public member-constructed methods, each of which corresponds to a description of the construction method.
• Class Member Method Summary: All protected and public member methods, each method corresponding to a sentence description.
• Class Inheritance Method list: A list that inherits the parent class method.
• Class domain details: Protected and public of the range of detailed description and links.
• Class Construction method Details: A detailed description of the construction methods for protected and public, method parameters, return values, throw exception descriptions, and associated links.
• Class member method Details: A detailed description of the member methods for protected and public, method parameters, return values, throw exception descriptions, and links to the associated content.
JBuilder provides a number of features that support Javadoc, including:
• The annotation structure of class, interface, method, range, and constructor can be created by shortcut keys, and the annotation structure contains the label corresponding to the source code.
• Induction input of Javadoc label Javadocinsight.
• @todo tags can be added via shortcut keys and can be browsed.
• Report and fix Javadoc annotations that conflict with source code.
• Create an entire project's Javadoc documentation through Archiver Builder.
• Create a custom Javadoc label
• Use Doc browser to browse the Javadoc documentation for program Files
