documentationjs/documentation

ES6 support

Open

#29 建立於 2015年3月18日

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