Microsoft/TypeScript

Support formatting JSDoc comments

Open

#11,500 opened on Oct 10, 2016

View on GitHub
 (2 comments) (3 reactions) (0 assignees)TypeScript (6,726 forks)batch import
Domain: JSDocHelp WantedSuggestionVS Code Tracked

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Study the TypeScript compiler's formatting logic for comments, specifically how JSDoc comments are currently processed, and modify the relevant AST visitor to apply correct indentation and spacing.
Tech stack
typescript
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65