CARVIEW |
Select Language
HTTP/2 200
date: Sun, 20 Jul 2025 12:04:15 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-robots-tag: none
etag: W/"38f4eefcfb7dd8f235c45151222ddd04"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=qlrvD40VwtKHtSLSeBwavkxyJ6080SHkahtxMexih2cEFRkQQahhAHKk3D5hGb5qLBCb8IddMHyQjK8MR8ewGenvJAOJKafePOPDd%2F8a0Y%2FMUqns7ov%2Bwe%2FoFfrOwMoc0GoovBcmUIsMV71qkvqa5laX5guD%2BTBED6T2M921qAd2948K%2BTPOnFvPbZajlQkzvksEHZxO9VbJCYEq0QIQq7of7u0Ya6pBxJdwHZMldX46O0FQBG5nl%2FkXXm42ACbufO6wF8CKFRoRJhpHqNUnDQ%3D%3D--BSJ3Vjq8F8rX%2BfOS--6Axj%2BlWmG9aHTRFqxIq9yA%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.1069006568.1753013055; Path=/; Domain=github.com; Expires=Mon, 20 Jul 2026 12:04:15 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Mon, 20 Jul 2026 12:04:15 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: 9D2A:36E64:2B02:377A:687CDB3F
How to document a CommonJS module (exports) · jsdoc2md/jsdoc-to-markdown Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 151
How to document a CommonJS module (exports)
Lloyd Brookes edited this page Oct 13, 2016
·
3 revisions
1. Say your module exports variable, class or function identifiers:
/**
* @module example
*/
/**
* @type {number}
*/
var one = 1
/**
* A method
*/
function two () {}
exports.one = one
exports.two = two
2. As the two inner declarations have documentation, they are shown in the output (not the exports
expressions, as they are not documented):
Kind: inner property of example
A method
Kind: inner method of example
3. To correctly represent those inner declarations as the exported values, we need to set @alias
tags:
/**
* @module example
*/
/**
* @type {number}
* @alias module:example.one
*/
var one = 1
/**
* @type {number}
* @alias module:example.two
*/
var two = 2
exports.one = one
exports.two = two
4. Using the @static
tag has the exact same effect, and looks cleaner:
/**
* @module example
*/
/**
* @type {number}
* @static
*/
var one = 1
/**
* @type {number}
* @static
*/
var two = 2
exports.one = one
exports.two = two
5. Now the output looks more realistic:
Kind: static property of example
Kind: static property of example
- Home
- How jsdoc2md works
- Additional jsdoc tags supported
- Cherry picking which documentation appears in output
- Showcase ...
- Create ...
- How To ...
- How to use with npm run
- How to use with gulp
- How to create one output file per class
- How to document a AMD module
- How to document a CommonJS module (exports)
- How to document a CommonJS module (module.exports)
- How to document an ES2015 module (multiple named exports)
- How to document an ES2015 module (single default export)
- How to document Promises (using custom tags)
- How to document a ToDo list
- How to document ES2017 features
- How to document TypeScript
- The @typicalname tag
- Linking to external resources
- Param list format options
- Listing namepaths
- Troubleshooting
Clone this wiki locally
You can’t perform that action at this time.