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.