Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
Gimleux edited this pageMar 2, 2022 ·19 revisions

documentation is a documentation generator for API documentation.It uses a code scanner and supports structured documentation, so it followsin the tradition of tools like JavaDoc,Natural Docs, andJSDoc. There areother camps of documentation generation, like literate documentation, whichis less structured and more focused on understanding internal code structure.

Full-Fledged JSDoc

Literate Style

Testing for the presence of documentation

  • Inch CI measures the percentage of source code that is described by JSDoc comments

Testing documentation itself

  • jsdoctest tests code examples in@example tags.

JavaScript Syntax Extensions

Alternative Syntaxes

Standalone JSDoc Parsers

JSDoc to Markdown

JSDoc Parse APIs

TypeScript

React

JSDoc to Flow / as Flow

Mixed JSDoc & Narrative


[8]ページ先頭

©2009-2025 Movatter.jp