Microsoft/TypeScript

Support formatting JSDoc comments

开放

#11,500 创建于 2016年10月10日

在 GitHub 查看贡献者指南
 (2 条评论) (3 个反应) (0 位负责人)TypeScript (13,395 个派生)batch import
Domain: JSDocHelp WantedSuggestionVS Code Tracked

仓库指标

星标
 (108,860 个星标)
PR 合并指标
 (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