java - 类上的@param javadoc

标签 java eclipse javadoc

我的 eclipse 具有以下代码模板 -> 注释 -> 类型:

/**
 * @author ${user}
 *
 * ${tags}
 */

类的时候

public class MyProtocol<T extends ProtocolContext> extends Protocol<ExtendProtocolContext> {

当我向类添加评论时

/**
 * @author user
 *
 * @param <T>
 */

我没有找到@param用于How to Write Doc Comments中的

@param (methods and constructors only)

关于方法为

  * @param text  the text of the tool tip
  */
  public void setToolTipText(String text) {

应该@param类里面也存在吗?如果不是,是 Eclipse 问题吗?

最佳答案

根据此:

https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#@param

它也应该用于类:

/**
  * @param <E> Type of element stored in a list
  */
 public interface List<E> extends Collection<E> {
 }

最新文档中也是这样:

https://docs.oracle.com/en/java/javase/11/docs/specs/doc-comment-spec.html

关于java - 类上的@param javadoc,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/53611956/

相关文章:

java - 生成 Javadoc

java - 谷歌图片搜索 : How do I construct a reverse image search URL?

java - Apache Http UrlBuilder 从 URL 中剥离 API 版本

java - maven-shade-plugin 报告 : Error creating shaded jar: . ..target/classes(是一个目录)

eclipse - 为什么我看不到@param 名称和描述之间的破折号?

java - Eclipse如何重构Javadoc源码注释?

java - Struts 2 S2-016 漏洞缓解直至升级

java - 使用 iText 从多个模板创建单个 PDF 文件

java - Eclipse RCP,改变视角

java - 使用 Stanford CoreNLP - Java 堆空间