documentationjs/documentation

ES6 support

Open

#29 opened on 2015年3月18日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)JavaScript (5,751 stars) (557 forks)batch import
help wanted

説明

Currently blocked by lack of parser support: http://esprima.org/doc/es6.html

Running list of things to support:

  • Switch to espree

  • JSDocs in destructuring assignment:

    { /** docs */ a, /** docs */ b } = { ... }

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

技術スタック
javascript
領域
documentation
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
JavaScriptJSDocNode.jsdocumentationjs
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
First, understand how documentationjs currently parses JSDoc comments by examining the parser integration, likely in src/parsers/. The switch to espree is already done, so focus on destructuring assignment AST nodes. Look at espree's output for destructuring patterns and identify where JSDoc comments are attached. Then modify the comment extraction logic to also capture leading comments for destructured parameters. Check existing tests for destructuring support and add similar ones. Review any comments in the issue for additional context.
ES6 support · documentationjs/documentation#29 | Good First Issue