问题标签 [javadoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
oop - 我们放在方法声明上方的文档的正确术语是什么？
我正在写一份白皮书，并意识到我不确定我们在定义声明之前作为注释块放置的那种内部文档的官方术语是什么。
最终成为 JavaDoc 成员文档的相同内容。
这不仅仅是内部文档，我不确定“标题文档”是否是一个好词。
请注意，我正在寻找一个通用术语，而不是特定于特定语言的术语（例如，Java/Perl）
java - 用于 IntelliJ IDEA 的类似 Ghostdoc 的插件
我晚年变得懒惰。对于我的 C# 工作，我非常依赖 Roland Weigelt 的 Visual Studio 优秀GhostDoc插件。
有人知道 IntelliJ IDEA 中有类似的 Java 插件吗？
xml - Checkstyle 的 PackageHtml 规则忽略 package-info.java
我使用 checkstyle 来分析我的代码。一个有用的规则是 PackageHtml，它检查包是否包含 Javadoc 描述。但是对于较新的 java 版本，建议使用 package-info.java 而不是 package.html。问题是，checkstyle 忽略 package-info.java 并报告违反规则。如何将 checkstyle 配置为检查包文档，但接受 package.html和package-info.java？
java - 使用 JavaDoc 记录 Java 枚举的最佳方法是什么？
我刚刚开始在我自己的项目中使用 Java 的枚举（我必须在工作中使用 JDK 1.4），我对使用 JavaDoc 进行枚举的最佳实践感到困惑。
我发现这种方法有效，但生成的代码有点不完善：
有没有什么办法可以在自己的行上分解枚举声明而不用逗号链接它们，或者这是使用 JavaDoc 进行枚举的最佳方法？
java - 您编写的每个方法都使用 Javadoc 吗？
我应该为我所有的 java 方法写 Doc Comments 吗？
visual-studio-2008 - 如果我对我自己的函数使用 Javadoc 样式的注释，MS Visual Studio 2008 会显示帮助吗？
例如在 C# 或 JavaScript 文档中。
如果没有，在 ASP.NET 编程中使用Javadoc注释是否有意义？
javadoc - 将 Javadoc 附加到 NetBeans 中的库
我是使用 NetBeans IDE 的新手。当我尝试查看说 java API（示例、System类）的文档时，它说没有安装 javadoc。如何安装文档？
delphi - delphi 的代码文档，类似于 javadoc 或 c# xml doc
对于 delphi 代码，我需要一个类似于 javadoc 或 c# xml doc 的代码文档工具。什么是最好的工具？我更喜欢一种技术，它在未来与微软沙堡项目兼容。
java - 当 javadoc-comments 中遗漏了某些内容时，是否可以从 javadoc 获得警告？
在记录方法或类等时，我可能会意外地忘记描述一些参数或异常抛出（或其他东西）。
是否可以以警告我缺少文档项的方式运行 javadoc？
（我使用 ant 脚本生成文档）
java - 分组 javadoc 方法
我想为我的班级分组 javadoc 中的方法。例如：
你知道我可以在javadoc中实现这个吗？是否有任何 doclet 可用于执行此操作？
谢谢，卡鲁姆