Fatal编程技术网
  • java/
  • 如何像Java文档一样用Java文档记录我的方法？

如何像Java文档一样用Java文档记录我的方法？

java documentation

如何像Java文档一样用Java文档记录我的方法？,java,documentation,javadoc,Java,Documentation,Javadoc,我希望当我将鼠标放在一个方法上时，我能够看到我的文档，说明当我将鼠标放在Java的方法上时，该方法是什么样子的，我知道/***/是如何完成的，但是： 你如何解释Params代表什么 如何创建新行，或使单词加粗或斜体 你如何解释Params代表什么 使用@param标记： /** * @param paramName Explanation of the param */ public void foo(String paramName); 如何创建新行，或使单词加粗或斜体 在大多数主要的I

我希望当我将鼠标放在一个方法上时，我能够看到我的文档，说明当我将鼠标放在Java的方法上时，该方法是什么样子的，我知道/***/是如何完成的，但是：

  • 你如何解释Params代表什么

  • 如何创建新行，或使单词加粗或斜体

    • 你如何解释Params代表什么

    使用
    @param
    标记：

    /**
 * @param paramName Explanation of the param
 */
public void foo(String paramName);
    如何创建新行，或使单词加粗或斜体

    在大多数主要的IDE中，如IntelliJ的IDE、ApacheNetbeans或Eclipse中，使用标准HTML，即
    、

    、
    和
    ）
    ；你可以打字
    

    /**

    
然后按enter键，它将为您的方法生成Javadoc，包括参数、返回值等。您只需要输入描述
    
这同样适用于类声明（Javadoc注释始终与以下元素相关）
    
例如
    

    /**
 * create_instance
 * @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
 * respectively.
 * @return Instance object
 */

    

    请阅读实际使用的功能。您可以对IntellijQuery执行相同的操作，而无需在注释顶部指定方法名称。不管有没有它都可以。