Exports all jsdocs-style comments from either
This is used as a workaround for when the TypeScript compiler strips jsdoc comments from its output. By extracting the comments first, you can run the output directly from
.ts files into jsdocs.
npm i gulp-comments --save-dev
The examples below illustrate usage in a gulp file. (Note that this plugin auto converts all file extentions to
for the benefit of jsdocs.)
Write the comments directly to files:
var gulp = ;var comments = ;gulp;
Stream comments directly into
var gulp = ;var comments = ;var jsdoc = ;gulp;
An optional filter parameter can be added when calling
comments(). Any jsdoc block containing this string will be excluded from publishing. Can be useful for creating custom documentation builds.