[TOC] # Javadoc支持许多标签和格式化标记 >## 常用的标签: - /** */:文档注释,会被Javadoc工具解析生成文档。 - @author:标识一个类的作者。如:@author John Doe - @version:标识软件的版本。如:@version 1.0 - @param:描述方法的参数。如:@param name 传入名称 - @return:描述方法的返回值。如:@return The greeting message - @exception:描述方法可能抛出的异常。如:@exception InvalidNameException 如果名称无效 - {@code }:用于标识代码示例。如:{@code if (name == null) } - @see:添加指向其他元素的链接。如:@see #sayGoodbye(String) - @deprecated:标记已过时的程序元素。如:@deprecated 不再使用此方法 > ## 其他标签如: - @throws:与@exception相同,描述可能抛出的异常 - {@literal }:与{@code }相同,用于代码示例 - @link:与@see相同,添加指向其他元素的链接 - @since:标识元素自哪个版本开始 - @serial:文档化对象序列化 - 等等 # 示例 ``` /** * @author John Doe * @version 1.0 */ // 类注释,包含@author标签标识作者和@version标签标识版本 public class Example { // 类定义开始 /** * Returns a greeting. * * @param name The name of the person to greet * @return The greeting * @throws InvalidNameException If the name is invalid * @see #sayGoodbye(String) */ // 方法注释,包含: // - 方法说明 // - @param标签描述参数 // - @return标签描述返回值 // - @throws标签列出可能抛出的异常 // - @see标签指向sayGoodbye方法 public String sayHello(String name) throws InvalidNameException { // 方法定义,包含参数name和可能抛出的异常InvalidNameException if (name == null || name.trim().isEmpty()) { throw new InvalidNameException("Name cannot be empty"); } // 方法主体,校验参数name,如果为空或只含空格抛出异常InvalidNameException return "Hello " + name; } // 返回包含姓名的问候语 /** * Prints a greeting to the standard output. * * @param name The name of the person to greet */ public void printHello(String name) { // printHello方法注释和定义,包含@param标签描述参数name System.out.println(sayHello(name)); } // 方法主体,调用sayHello方法并打印返回值 /** * Returns a goodbye message. * * @param name The name of the person to say goodbye to * @return The goodbye message */ public String sayGoodbye(String name) { return "Goodbye " + name; } // sayGoodbye方法注释和定义,包含@param描述参数和@return描述返回值 // 方法主体返回告别语 } // 类定义结束 ```