Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

single line comment to doc comment #796

Open
tjx666 opened this issue Jan 15, 2023 · 0 comments
Open

single line comment to doc comment #796

tjx666 opened this issue Jan 15, 2023 · 0 comments
Assignees
Labels
✨ Feature New refactoring or feature

Comments

@tjx666
Copy link
Contributor

tjx666 commented Jan 15, 2023

scene 1

  • not follow with function or function variable
  • single line comment only one line

before:

interface Props {
    // some comment
    a: number;
}

after:

interface Props {
    /** some comment */
    a: number;
}

scene 2

  • not follow with function or function variable
  • single line comment has multiple lines
interface Props {
    // comment line 1
    // comment line 2
    a: number;
}

after:

interface Props {
    /**
     * comment line 1
     * comment line 2
     */
    a: number;
}

scene 3

  • follow with function
// add two number
function add(a, b) {

}

after:

/**
 * add two number
 */
function add(a, b) {

}

scene 4

  • function variable
// add two number
const add = (a, b) => {

}

after:

/**
 * add two number
 */
const add = (a, b) => {

}
@tjx666 tjx666 added the ✨ Feature New refactoring or feature label Jan 15, 2023
@nicoespeon nicoespeon self-assigned this Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Feature New refactoring or feature
Projects
None yet
Development

No branches or pull requests

2 participants