microsoft / microsoft/TypeScript
Feature Request: Split out JsDoc comments for constructor function when convert function to ES2015 class
Open
Nobody has claimed this yet.
Awaiting More Feedback
Domain: LS: Refactorings
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Add ability to convert JsDoc comments in following situation:
/**
* @class
* Some constructor description.
* @classdesc
* Some class description
*/
function Class() {}
must be converted to
/**
* Some class description
*/
class Class {
/**
* Some constructor description.
*/
constructor() {}
}
Right now you get following result:
/**
* @class
* Some constructor description.
* @classdesc
* Some class description
*/
class Class {
constructor() {}
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named. Start by locating the function-to-ES2015-class conversion and its JsDoc handling; done means @classdesc becomes the class comment while the constructor description becomes the constructor comment, as shown in the examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100