_142_javadocs.java

/*
    Comments In JavaDoc :
    Like Java programs, we can also include comments in Java documentation for a better understanding.
    A JavaDoc comment is known as doc comment in general.
    Syntax : /** Documentation comment */       // must use double star after the first slash

//Including HTML inside the JavaDoc :
//You can include HTML tags in the JavaDoc.
//Example :
/**
 * @author Harry (CodeWithHarry)
 * @version 0.1
 * @since 2002
 * @see <a href="https://docs.oracle.com/en/java/javase/14/docs/api/index.html" target="_blank">Java Docs</a>
 *
 * <i>This is a simple documentation to show that HTML elements can be included in JavaDoc.</i>
 * @see <a href="https://www.codewithharry.com/videos/java-tutorials-for-beginners-1">
 *              Best Java Course Available For <b>Free</b></a>
 */
public class _142_javadocs {
    public static void main(String[] args) {
    /*
    Below is the list of the JavaDoc tags :
    Tag	            Syntax	                                Description

    @author	        @author name-text	                    Describes the author of a class.

    @version	    @version version-number	                Adds a "Version" heading which specifies the current
                                                            version of the release or file.

    @since	        @since release-date	                    Adds a "Since" heading that tells about the release
                                                            date.

    @see	        @see <a href="reference"></a>	        Adds a "See Also" heading that refers to the other
                                                            element of the documentation.

    @return	        @return return-description	            Adds a "Return" description that tells about the
                                                            return value of the method.

    @param	        @param param-description	            Provides the information about the method parameters
                                                            in the "Parameters" section.

    @throws	        @exception exception-name description	Displays the exception that can be thrown by a method
                                                            ( same as @exception)

    {@code}	        {@code text}	                        Displays text in code font without interpreting the
                                                            text as HTML markup or nested javadoc tags.

    @deprecated     @deprecated deprecated-text	            Adds a "Deprecated" heading indicating that this API
                                                            should no longer be used.
    */
    }
}