Turns a string into a JSDoc comment
Package: string-to-jsdoc-comment
Created by: gr2m
Last modified: Wed, 18 May 2022 20:55:08 GMT
Version: 1.0.0
License: ISC
Downloads: 476
Repository: https://github.com/gr2m/string-to-jsdoc-comment
Install
npm install string-to-jsdoc-comment
yarn add string-to-jsdoc-comment
string-to-jsdoc-comment
Turns a string into a JSDoc comment
const { stringToJsdocComment } = require('string-to-jsdoc-comment')
const comment = stringToJsdocComment('Here is some description.')
comment is now
/**
* Here is some description.
*/
Credit
This method was extracted from @octokit/rest. The original method was implemented by @gimenete.
