documentationjs/documentation

support @memberof with namepaths including instance and inner members

Open

#189 创建于 2015年10月16日

在 GitHub 查看
 (2 评论) (1 反应) (0 负责人)JavaScript (5,751 star) (557 fork)batch import
enhancementhelp wanted

描述

Examples:

  • @memberof Parent# (equivalent to @memberof Parent, @instance)
  • @memberof Parent~ (equivalent to @memberof Parent, @inner)
  • Nested paths such as @memberof Parent#Child

贡献者指南

技术栈
javascript
领域
documentationtooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
JSDoc namepathsdocumentationjs codebase
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
Investigate the current parsing logic for @memberof in the codebase (likely in lib/parse.js). Determine how to extend it to support trailing # and ~ symbols and nested paths. Check if there are existing tests for @memberof. Consider adding corresponding test cases. Look at the JSDoc specification for namepaths to ensure correctness.