microsoft / microsoft/TypeScript

Support formatting JSDoc comments

オープン
#11,500 コメント 2 件 リアクション 3 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Domain: JSDoc Help Wanted Suggestion VS Code Tracked
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

Formatting:

/**
      *    @param  { Object }    bar 
                */
function foo(bar) { }

Should result in:

/**
 * @param {Object} bar 
 */
function foo(bar) { }

Reported originally in https://github.com/Microsoft/TypeScript/issues/11456

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、issue の TypeScript 例を再現し、現在の formatter の出力と期待される JSDoc のフォーマットを比較します。インデント、@param の型と名前の間のスペース、終了デリミターが期待される出力と一致し、関数を変更していなければ完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
tooling
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。