redhat-developer / redhat-developer/vscode-java

Feature suggestion: Show warning when javadoc doesn't match the method signature and offer a code action to update it

未关闭
#3,768 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

code action diagnostics enhancement javadoc
主要语言
TypeScript
星标
2.3k
派生
546
平均合并
20 小时 1 分钟
30 天内合并 PR
11

描述

It’s difficult to remember to update the Javadoc of a method after modifying its signature. It would be practical if the extension could detect this mismatch, show a warning, and propose an update.

Environment
  • JDK version: 17
  • Visual Studio Code version: v0.29.0
  • Java extension version: 1.93.1
Steps To Reproduce
  1. Generate a java doc for a method
  2. Add a new argument to the method
Current Result

An outdated javadoc

Expected Result
  1. Show a warring
  2. Execute a code action to update the javadoc
  3. An updated javadoc

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

未确定文件、测试或入口点。首先使用 JDK 17、VS Code 0.29.0 和 Java extension 1.93.1 重现不匹配,然后定位 extension 的 diagnostic 和 code-action 入口点。当签名不匹配产生警告和一个更新 Javadoc 的 action 时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
java, typescript, vscode
领域
developer-experience, tooling
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。