skills.rest
sarkarshivaditya-lab
sarkarshivaditya-labCOMMUNITY
Explore all skills by this author →
GitHub

inline-documentation

Writes JSDoc, docstrings, and inline comments for TypeScript, JavaScript, and Python code.

Updated Jan 1, 2026
Search Tags:#typescript#python#jsdoc#docstrings#code documentation#inline comments#typedoc
One-click install
npx skills add https://github.com/sarkarshivaditya-lab/WellMate --skill inline-documentation-sarkarshivaditya-lab
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: inline-documentation
Source: https://github.com/sarkarshivaditya-lab/WellMate/tree/main/.engineering-skills/troykelly-claude-skills/skills/inline-documentation
Command: npx skills add https://github.com/sarkarshivaditya-lab/WellMate --skill inline-documentation-sarkarshivaditya-lab

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code without documentation slows onboarding, hides design decisions, and prevents automated API documentation generation. This Skill ensures every public function, class, and interface is documented with complete JSDoc or docstrings so tools like TypeDoc and Sphinx can generate docs directly from source. ## Core Features & Use Cases - Language-Specific Templates: Provides complete JSDoc patterns for TypeScript/JavaScript and Google-style docstring patterns for Python, covering functions, classes, and interfaces. - Inline Comment Guidance: Teaches when to comment (complex algorithms, non-obvious decisions) and how to explain why rather than what, including links to RFCs and issue trackers. - Documentation Checklists: Supplies per-element checklists for parameters, return values, exceptions, and examples, plus anti-pattern tables to avoid stale or obvious comments. - Use Case: While implementing a new authentication service, apply this Skill to produce fully documented classes and methods that TypeDoc can render into an API reference site without extra writing. ## Quick Start Add complete inline documentation with JSDoc comments and explanatory inline comments to the code in this file.

Frequently Asked Questions about inline-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write JSDoc comments for TypeScript functions?▼

JSDoc comments use a block starting with a brief description, followed by @param tags for each argument, @returns for the output, and @throws for exceptions. Add an @example block for non-obvious usage so generated docs include runnable samples.

How to write Python docstrings for classes and methods?▼

Python docstrings start with a one-line summary, then a detailed description, followed by Args, Returns, and Raises sections. Class docstrings should document attributes and include a usage example, while each public method gets its own docstring.

When should I add inline comments in code?▼

Add inline comments for complex algorithms, non-obvious decisions, and order-dependent operations. Comments should explain why something is done, not what the code does, and can link to RFCs or issue trackers for context.

What code elements should not be documented?▼

Skip documentation for private trivial helpers, single-line getters, standard well-known patterns, and test files. These elements are self-evident from their names, and documenting them adds noise without value.

Which tools generate documentation from JSDoc and docstrings?▼

TypeDoc and API Extractor generate documentation from TypeScript JSDoc comments. For Python, Sphinx with sphinx-apidoc or pdoc converts docstrings into HTML documentation sites.

Related Skills

Explore More Software Engineering Skills→
ShunsukeHayashiShunsukeHayashi

doc-generator

Generate JSDoc, README, API references, and CHANGELOGs from code.

Community
Intermediate
thkim2015thkim2015

moai-docs-generation

Generate API documentation from code using Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced
gaebalaigaebalai
2

pr-quality-gate

Run automated quality checks on pull requests before submission.

Community
Intermediate
plaitedplaited
6

code-documentation

Standardize TSDoc documentation across TypeScript and JavaScript codebases.

Official
Intermediate