Imports jsDoc comments from external files, via jsDoc-like reference:
/**
* @docref
* @file src/product.js
* @match Product.buy
*/
buy(id: string, count: number):Receipt
See the Rationale for this project.
IMPORTANT: It is currently at the stage of writing Specification.
$npm install docref -g
Run docref without arguments, to see the supported syntax.
FAQs
Code documentation by reference
The npm package docref receives a total of 1 weekly downloads. As such, docref popularity was classified as not popular.
We found that docref demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.