agentsclimarketplace

Inline docs

Skill ethan-ngai/skills/skills/inline-docs

Practical, composable agent skills for engineering work and personal development.

Install
npx -y skills add ethan-ngai/skills --skill inline-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Document code using efficient inline comments. Use whenever writing, editing, or reviewing code or if the user mentions documentation.

The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

1.7 KB, as published. Nobody here has run it

Inline Documentation

Documentation remedies ambiguity and supplies missing context. Good code is self-documenting — it shows the what, so a comment must earn its place by adding the why. Keep docs lean.

What to document

  • Comment where the code surprises: intent, constraints, workarounds, logic that looks wrong but works. Add the why when it spares the reader a wrong guess; let plain code speak for itself.
  • Reserve inline comments for genuinely complicated logic; short phrases.
  • Mark unfinished work with TODO/FIXME.
  • Keep a comment beside its code and revise both in one edit; comments rot as code drifts.
  • Write for the future reader, who knows the code but not your session or the surrounding stack: keep comments timeless and self-contained.

How to write it

  • Use block doc comments (JavaDoc, JSDoc, docstrings) for the standard, dev-readable format.
  • Write like a senior developer: terse fragments, human names, specific over generic.
  • Every comment is signal: cut the noise (keeps, so, because, stays), and prefer commas and semicolons to full sentences.
  • Shun ceremony: structure speaks for itself, so section headers like // -------- Variables -------- only bloat tokens.
  • Use typeable ASCII only; it keeps docs easy to edit.

Language References

Load in the specific documentation standard(s) for the current project:

LanguageReference
JavaScript/TypeScriptJSDoc

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.