如何在JavaDoc中复用多签名方法文档，避免重复编写？

针对重载方法不想重复编写核心逻辑文档的需求，有几种简洁的方式可以关联核心方法的文档，避免重复劳动：

1. 使用{@link}标签直接关联核心方法 #

在重载方法的JavaDoc中，用{@link}指向核心实现方法的完整签名，同时说明当前重载的参数默认值或适用场景即可，无需重复核心逻辑。

修改后的代码示例：

/**
 * 格式化字符串的核心方法
 * 
 * @param s 待格式化的字符串
 * @param bold 是否启用粗体格式
 * @param cursive 是否启用斜体格式
 *                
 * @return 格式化后的字符串 
 */
public static String formatMe(String s, Boolean bold, Boolean cursive){
    String res = s;

    // 处理粗体选项
    if (bold) {
        res = "BOLD" + res + "BOLD";
    }

    // 处理斜体选项
    if (cursive) {
        res = "KURSIVE" + res + "KURSIVE";
    }

    return res;
}

/**
 * 便捷重载：使用空字符串、非粗体、非斜体的默认参数调用{@link #formatMe(String, Boolean, Boolean)}
 * @return 格式化后的字符串
 */
public static String formatMe(){
    return formatMe("", false, false);
}

/**
 * 便捷重载：调用{@link #formatMe(String, Boolean, Boolean)}，默认不启用粗体和斜体
 * @param s 待格式化的字符串
 * @return 格式化后的字符串
 */
public static String formatMe(String s){
    return formatMe(s, false, false);
}

2. 使用@see标签补充关联 #

如果需要更正式地说明关联关系，可以用@see标签指向核心方法，适合需要强调参考核心实现的场景：

/**
 * 便捷重载：使用默认参数格式化字符串
 * @see #formatMe(String, Boolean, Boolean) 核心实现方法，详细逻辑请参考该方法文档
 * @return 格式化后的字符串
 */
public static String formatMe(){
    return formatMe("", false, false);
}

3. 极简表述+明确指向 #

如果追求极致简洁，直接说明当前方法是核心方法的重载，参数采用默认值即可：

/**
 * {@link #formatMe(String, Boolean, Boolean)}的便捷重载，默认参数：空字符串、非粗体、非斜体
 * @return 格式化后的字符串
 */
public static String formatMe(){
    return formatMe("", false, false);
}

注意事项 #

• {@link}中的方法签名必须完整（包含参数类型），避免多个重载时出现歧义
• 重载方法的JavaDoc只需聚焦自身的参数默认值或适用场景，无需重复核心方法的逻辑说明
• 在主流IDE中，点击{@link}或@see指向的方法链接，可直接跳转到核心方法查看完整文档

内容的提问来源于stack exchange，提问作者petermeissner