redhat-developer / redhat-developer/vscode-java

Feature suggestion: Add Javadoc for 'ClassName'

Open
#2,604 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

code action enhancement
Dominant language
TypeScript
Stars
2.3k
Forks
546
Avg merge
20h 1m
Merged PRs (30d)
11

Description

Add Javadoc for 'Class'

Environment
  • Operating System: Windows 10
  • JDK version: 17.0.2
  • Visual Studio Code version: 1.69.2
  • Java extension version: v1.9.0
Steps To Reproduce
  1. Add a class
  2. cursor move to class name
  3. Hit Ctrl+. (Show Code Actions)
  4. I can't find a command called Add Javadoc for 'ClassName'
Current Result

There is already a Add Javadoc for 'MethodName' command.

image

Expected Result

I expected there is a Add Javadoc for 'ClassName' command.

Additional Informations

N/A

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the VS Code Code Actions entry point described in the reproduction steps and compare it with the existing Add Javadoc for 'MethodName' command. Add the corresponding class-name action, then verify that it appears when the cursor is on a class name and produces the expected Javadoc behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, typescript, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.