Microsoft/TypeScript

Support formatting JSDoc comments

Open

#11,500 建立於 2016年10月10日

在 GitHub 查看
 (2 留言) (3 反應) (0 負責人)TypeScript (48,455 star) (6,726 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.