Intellij 的 javadoc 自动生成

发布于 2024-10-11 12:56:09 字数 134 浏览 2 评论 0原文

IntelliJ 有自动生成 Javadoc 的插件吗?示例 http://jautodoc.sourceforge.net/

Is there an automatic Javadoc generation plugin for IntelliJ? Example http://jautodoc.sourceforge.net/

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

泛泛之交 2024-10-18 12:56:09

Javadoc 生成(编写 .html 文件)是按需完成的(“工具”->“生成 Javadoc”),并且在您设置后基本上是自动的。生成 javadoc 存根(这就是 Eclipse 的 jautodoc 所做的事情)是逐个方法、逐个类完成的,并且仅在您指定的位置完成。

在方法签名上方键入 /** 将为您创建 Javadoc 存根。我怀疑你想要一些可以对整个文件、包或项目执行此操作的东西(例如 jautodoc)。曾经有这样一个插件: http://plugins.intellij.net/plugin/?id=952 但它不适用于 10。

我不得不说这个 jautodoc 示例虽然是一个巧妙的聚会技巧,但却是我在 IDE 中见过的最无用的东西:它根据变量名称创建一个描述- 但前提是变量名称具有描述性,以至于一开始就不需要注释。

/**
 * The number of questions
 */
private int numberOfQuestions;

让你向往打孔卡。

Javadoc generation (writing the .html files) is done for you on-demand (Tools->Generate Javadoc) and is essentially automatic once you set it up. Generating javadoc stubs, which is what jautodoc for Eclipse does, is done method-by-method, class-by-class and only where you tell it to.

Typing /** <enter> above a method signature will create Javadoc stubs for you. I suspect you want something that will do this for an entire file, package or project though (like jautodoc). There used to be such a plugin: http://plugins.intellij.net/plugin/?id=952 but it won't work with 10.

I do have to say that this jautodoc example, while a neat party trick, is the single most useless thing I've ever seen in an IDE: It creates a description based on the variable name - but only if the variable name is so descriptive that it doesn't need a comment in the first place.

/**
 * The number of questions
 */
private int numberOfQuestions;

Makes you yearn for punched card.

戏舞 2024-10-18 12:56:09

更新了 IntelliJ 2020.3 版本的答案(也适用于 2019.2

  1. 下载插件“JavaDoc< /em>" (Ctrl + Shift + A > 插件 > 市场 选项卡 > 搜索 JavaDoc(供应商:“Sergey Timofiychuk”)> 安装)

并按照以下步骤操作(从步骤 2 开始)。

--先前的答案--

2018.2 版本的 IntelliJ

  1. Download 插件“JavaDoc2”中进行了测试(Ctrl + Shift + A > 插件 > 浏览存储库... > JavaDoc2)
  2. 重新启动 strong> IntelliJ (文件 > 无效缓存/重新启动... > 只需重新启动)
  3. 对于当前元素: 要为当前元素(例如 setter 方法)生成 Javadoc,请按 Alt + Shift + G。如果由于不同的键盘映射关联而不起作用,请尝试 Alt + Insert 并选择 为所选元素创建 JavaDocs
  4. 整个类:要为整个类生成,请按Ctrl + Alt + Shift + G(或Alt + Insert 并选择为所有元素创建 JavaDocs

(需要注意的是,它仅为公共方法生成 javadoc,而不为字段和私有方法)

Updated the answer for 2020.3 version of IntelliJ (also works in 2019.2)

  1. Download plugin "JavaDoc" (Ctrl + Shift + A > Plugins > Marketplace tab > search for JavaDoc (by vendor: "Sergey Timofiychuk") > Install)

and follow below steps (from Step 2).

--PREVIOUS ANSWER--

Tested below in 2018.2 version of IntelliJ

  1. Download plugin "JavaDoc2" (Ctrl + Shift + A > Plugins > Browse Repositories... > JavaDoc2)
  2. Restart IntelliJ (File > Invalid Caches/Restart... > Just Restart)
  3. For current element: To generate Javadoc for current element (say a setter method), press Alt + Shift + G. If this doesn't work due to different keymap association, try Alt + Insert and selecting Create JavaDocs for the selected element
  4. Whole class: To generate for the whole class, press Ctrl + Alt + Shift + G (or Alt + Insert and selecting Create JavaDocs for all elements)

(One caveat is, it is generating javadoc only for public methods, not for fields and private methods)

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文