新的介绍内容:
Javadoc Tools:Visual Studio Code 的 Java 文档生成扩展
Javadoc Tools是一款为Visual Studio Code量身定制的扩展,旨在帮助Java开发者高效地生成和管理Javadoc注释。无论您是需要为整个工作区生成文档,还是只为特定方法或文件创建注释,Javadoc Tools都能满足您的需求。
主要功能:
导出Javadoc: 通过"Javadoc Tools: Export Javadoc"命令,您可以轻松地从工作区中导出Javadoc。支持多根工作区,并且可以自定义源文件夹、目标文件夹以及运行模式等设置。
javadoc-tools.generateJavadoc.workspaceSourceFolder
- 默认源文件夹设置为工作区根目录下的"src"文件夹javadoc-tools.generateJavadoc.targetFolder
- 目标文件夹路径设置为${WorkspaceRoot}\javadoc
javadoc-tools.generateJavadoc.runMode
- 运行模式可选值包括"-package", "-private", "-protected", "-public"javadoc-tools.generateJavadoc.isUsingPwsh
- 若使用Powershell作为默认终端,请设置为true为选择的方法生成注释: 使用"Javadoc Tools: Generate Comments for Select methods"命令,您可以选择特定的方法生成Javadoc注释。此功能也可通过文件内的右键上下文菜单触发。
为打开的文件生成Javadoc注释: "Javadoc Tools: Generate Javadoc Comments for Open File"命令仅为当前焦点文件生成Javadoc注释。
为工作区生成Javadoc注释: "Javadoc Tools: Generate Javadoc Comments for Workspace"命令可为工作区内的所有类生成Javadoc注释。请注意,在大型工作区中运行此命令可能会影响性能。
从上下文菜单生成Javadoc注释: 新增的"Generate Javadoc Comments"选项可在Java类的上下文菜单中找到,方便为选中的类生成Javadoc注释。
功能展示:
常见问题:
如果您在使用扩展过程中遇到任何问题,请在GitHub页面上提出问题:https://github.com/madhavd1/vscode-javadoc-tools
要求:
最新版本更新:
javadoc-tools.generateJavadoc.isUsingPwsh
属性,支持Powershell导出Javadoc。修复了由Lombok添加的方法(如Getters, Setters, Equals, Hashcode等)在生成Javadoc注释时被忽略的问题。优化了"Javadoc Tools: Generate Javadoc Comments for Workspace"命令的处理,增加了警告提示和进度条,并且支持取消操作。完整的版本历史请查看变更日志。
通过Javadoc Tools,Java开发者可以更高效地管理和生成代码文档,提升开发效率和代码质量。
本站所有资源都是由网友投稿发布,或转载各大下载站, 请自行检测软件的完整性!
本站所有资源仅供学习与参考,请勿用于商业用途,否则 产生的一切后果将由您自己承担!
如有侵权请联系我们删除下架,联系方式:study_golang@163.com