如何用Java文档记录我的Java方法?

我希望当我鼠标悬停在一个方法上时,我能够看到我的文档,当我将鼠标放在Java的方法上时,该方法的功能我知道/ ** * /是如何完成的但是:

>你如何解释Params代表什么?
>如何创建新行,或将单词设为粗体或斜体?

解决方法:

如果您使用Eclipse作为IDE,则只需创建注释即可

/**

然后按Enter键,它将为您的Javadoc生成代码,包括参数,返回值等.您只需要输入说明.

这同样适用于类声明(Javadoc注释始终与以下元素相关)

注意:

要将doc附加到方法,您需要在顶部的注释中指定方法名称.

例如

/**
 * create_instance
 * @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
 * respectively.
 * @return Instance object
 */
上一篇:python-Sphinx-自定义主题不起作用


下一篇:php – 我应该使用@return self,this还是当前的类?