microsoft / microsoft/TypeScript
Feature Request: Split out JsDoc comments for constructor function when convert function to ES2015 class
オープン
まだ誰も着手していません。
Awaiting More Feedback
Domain: LS: Refactorings
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
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() {}
}
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイル、テスト、エントリーポイントのいずれも指定されていません。まず、関数から ES2015 クラスへの変換と、その JsDoc の処理箇所を特定してください。完了条件は、例に示されているとおり、@classdesc がクラスのコメントになり、コンストラクターの説明がコンストラクターのコメントになることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, typescript
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100