Writing Comments

How to write JSDoc (/** */) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users. Use whenever writing or editing comments in .ts/.js source, including comments added incidentally while fixing bugs or building features. Does not cover the @docs-generated config/error reference.

withastro Updated
Build the web you want

File contents

withastro/astro commit e168aa9db3

Frequently asked questions

npx get-skill add withastro/writing-comments