JSDoc: add document

描述

貢獻者指南

技術棧

typescript

領域

documentation

議題類型

documentation

難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。

2

預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。

under 1 hour

活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。

stale

清晰度議題是否清楚說明預期改動、驗收標準和下一步。

clear

前置要求

basic TypeScript

新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。

90

研究方向

Review the repository's existing codebase to identify key functions and modules that lack JSDoc comments. Look at the current code style in files like src/index.ts for consistency. No linked PRs or comments specify exact locations, so focus on public API methods. The issue is from 2017 but still open, so confirm the code has not been heavily refactored. After identifying functions, add standard JSDoc annotations following TypeScript conventions.