The function of the jdk tool javadoc is to "generate Java documentation"; javadoc is a Java documentation generator that extracts comments such as classes, methods, members, etc. from the program source code to form an API help document that matches the source code.
Related recommendations: "Java Video Tutorial"
The function of the jdk tool javadoc is to "generate Java document".
Javadoc is a technology provided by Sun. It extracts comments such as classes, methods, members, etc. from the program source code to form an API help document that matches the source code. In other words, as long as you use a specific set of tags as comments when writing a program, after the program is written, the program's development documentation can be formed at the same time through Javadoc.
The javadoc command is used to generate your own API documentation. How to use it: Use the command line to enter the javadoc file name.java in the directory where the target file is located.
Common tags
Tags | Description | JDK 1.1 doclet | Standard doclet | Tag type |
@author author | author identification | √ | √ | Package, class, interface |
@version version number | version number | √ | √ | Package, class, interface |
@param Parameter name description | The input parameter name and description information of the method. If you have special requirements for the input parameters, you can this comment. | √ | √ | Constructor, method |
@return Description | The return value of the function Comment | √ | √ | Method |
@deprecated Expired text | identifies the program version Improvement, the current API has expired, just to ensure that compatibility still exists, and to inform developers that they should no longer use this API. | √ | √ | Package, class, interface, value range, constructor, method |
@throwsException class name | Exceptions thrown by constructors or methods. | √ | Constructor, method | |
@exception Exception class name | Same as @throws. | √ | √ | Constructor, method |
@see Quote | View related content, such as Classes, methods, variables, etc. | √ | √ | Package, class, interface, value range, constructor, method |
@since Description text | API is developed and supported after what program and what version. | √ | √ | Package, class, interface, value range, constructor, method |
{@link package. Class #Member Tag} | links to the document corresponding to a specific member. | √ | Package, class, interface, value range, constructor, method | |
{@value } | When annotating a constant, if you want to include its value in the document, reference the value of the constant through this label. | √(JDK1.4) | Static value field |
In addition, there is @serial , @serialField, @serialData, {@docRoot}, {@inheritDoc}, {@literal}, {@code} {@value arg} are several uncommon tags. Since they are not commonly used, we will not elaborate on them. Interested Readers can view the help documentation.
For more programming-related knowledge, please visit: Introduction to Programming! !
The above is the detailed content of What is the function of jdk tool javadoc?. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

To correctly handle JDBC transactions, you must first turn off the automatic commit mode, then perform multiple operations, and finally commit or rollback according to the results; 1. Call conn.setAutoCommit(false) to start the transaction; 2. Execute multiple SQL operations, such as INSERT and UPDATE; 3. Call conn.commit() if all operations are successful, and call conn.rollback() if an exception occurs to ensure data consistency; at the same time, try-with-resources should be used to manage resources, properly handle exceptions and close connections to avoid connection leakage; in addition, it is recommended to use connection pools and set save points to achieve partial rollback, and keep transactions as short as possible to improve performance.

TheJVMenablesJava’s"writeonce,runanywhere"capabilitybyexecutingbytecodethroughfourmaincomponents:1.TheClassLoaderSubsystemloads,links,andinitializes.classfilesusingbootstrap,extension,andapplicationclassloaders,ensuringsecureandlazyclassloa

Use classes in the java.time package to replace the old Date and Calendar classes; 2. Get the current date and time through LocalDate, LocalDateTime and LocalTime; 3. Create a specific date and time using the of() method; 4. Use the plus/minus method to immutably increase and decrease the time; 5. Use ZonedDateTime and ZoneId to process the time zone; 6. Format and parse date strings through DateTimeFormatter; 7. Use Instant to be compatible with the old date types when necessary; date processing in modern Java should give priority to using java.timeAPI, which provides clear, immutable and linear

Pre-formanceTartuptimeMoryusage, Quarkusandmicronautleadduetocompile-Timeprocessingandgraalvsupport, Withquarkusoftenperforminglightbetterine ServerLess scenarios.2.Thyvelopecosyste,

Networkportsandfirewallsworktogethertoenablecommunicationwhileensuringsecurity.1.Networkportsarevirtualendpointsnumbered0–65535,withwell-knownportslike80(HTTP),443(HTTPS),22(SSH),and25(SMTP)identifyingspecificservices.2.PortsoperateoverTCP(reliable,c

Java's garbage collection (GC) is a mechanism that automatically manages memory, which reduces the risk of memory leakage by reclaiming unreachable objects. 1.GC judges the accessibility of the object from the root object (such as stack variables, active threads, static fields, etc.), and unreachable objects are marked as garbage. 2. Based on the mark-clearing algorithm, mark all reachable objects and clear unmarked objects. 3. Adopt a generational collection strategy: the new generation (Eden, S0, S1) frequently executes MinorGC; the elderly performs less but takes longer to perform MajorGC; Metaspace stores class metadata. 4. JVM provides a variety of GC devices: SerialGC is suitable for small applications; ParallelGC improves throughput; CMS reduces

Gradleisthebetterchoiceformostnewprojectsduetoitssuperiorflexibility,performance,andmoderntoolingsupport.1.Gradle’sGroovy/KotlinDSLismoreconciseandexpressivethanMaven’sverboseXML.2.GradleoutperformsMaveninbuildspeedwithincrementalcompilation,buildcac

defer is used to perform specified operations before the function returns, such as cleaning resources; parameters are evaluated immediately when defer, and the functions are executed in the order of last-in-first-out (LIFO); 1. Multiple defers are executed in reverse order of declarations; 2. Commonly used for secure cleaning such as file closing; 3. The named return value can be modified; 4. It will be executed even if panic occurs, suitable for recovery; 5. Avoid abuse of defer in loops to prevent resource leakage; correct use can improve code security and readability.
