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.