redhat-developer / redhat-developer/vscode-java

Add feature for line up comment

Open
#2,399 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

background: format comment setting is disabled because for preserving whitespace of indentation

// void method()
// {
//     System.out.println("indented"); 
// }

This will make vscode so powerful that eclipse or other ide can't provide if vscode can:

  1. add option for line up comment even when format comment is disabled
class Test {
    void trailingCommented()
    {
        System.out.println("indented"); //comment
        System.out.println("indent"); //comment
    }
}

became

class Test {
    void trailingCommented()
    {
        System.out.println("indented"); //comment
        System.out.println("indent");   //comment
    }
}
  1. add option to add space after // even when format comment is disabled

became

class Test {
    void trailingCommented()
    {
        System.out.println("indented"); // comment
        System.out.println("indent");   // comment
    }
}

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

No files or tests are named. Search the repository for the format-comment setting and its comment-formatting implementation, then compare the behavior with the issue's examples; done means trailing comments can align and optionally gain a space after // while comment formatting remains disabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, typescript, vscode
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.