Microsoft/TypeScript

Support formatting JSDoc comments

Open

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

在 GitHub 查看
 (2 留言) (3 反應) (0 負責人)TypeScript (6,726 fork)batch import
Domain: JSDocHelp WantedSuggestionVS Code Tracked

倉庫指標

Star
 (48,455 star)
PR 合併指標
 (平均合併 6天 17小時) (30 天內合併 9 個 PR)

描述

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

貢獻者指南

研究方向
研究 TypeScript 編譯器中註解的格式化邏輯，特別是當前如何處理 JSDoc 註解，並修改相關的 AST 訪問器以應用正確的縮排和間距。
技術棧
typescript
領域
developer experience
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
TypeScript
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65