Microsoft/TypeScript

Support formatting JSDoc comments

Open

#11,500 opened on 2016年10月10日

GitHub で見る
 (2 comments) (3 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
Domain: JSDocHelp WantedSuggestionVS Code Tracked

説明

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

コントリビューターガイド

技術スタック
typescriptjavascript
領域
toolingdeveloper experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
TypeScript basicsunderstanding of JSDoc comments
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
This issue requests formatting JSDoc comments to a consistent style. Start by examining the TypeScript language service's formatting infrastructure in src/services/formatting/. Look for existing formatting rules for comments and how they are applied. The original issue link (https://github.com/Microsoft/TypeScript/issues/11456) may contain additional context. Consider writing a simple formatter that normalizes JSDoc indent and spacing, integrating it into the language service's formatting pipeline.