[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描述返回值 // 方法主體返回告別語 } // 類定義結束 ```