docref
Advanced tools
Readme
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 6 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.