# comment-builder

> JS Comment Builder

Latest version **0.1.0** (published 2015-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install comment-builder
pnpm add comment-builder
yarn add comment-builder
bun add comment-builder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-09-23 |
| First published | 2015-09-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael Rochelle |
| Maintainers | elitescientist |
| Keywords | commetbuilder, comment, builder, doc, comment builder |

## Links

- npm: https://www.npmjs.com/package/comment-builder
- Homepage: https://github.com/EliteScientist/comment-builder
- Issues: https://github.com/EliteScientist/comment-builder/issues
- npm.io page: https://npm.io/package/comment-builder

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2015-09-23

## README

# Javascript Comment Block Builder

This library allows you to build comment blocks. 

## Install

> use "npm install comment-builder" to download and install

## Examples
``` javascript
var CommentBuilder = require("comment-builder");

var builder	= new CommentBuilder();

builder.writeLine("Testing");
var comment = builder.toString()

--- Outputs
/**
 * Testing
 **/


var builder	= new CommentBuilder();

var block = {};
block.param   = "input {String} Input Parameter"; 
block.see     = "http://www.google.com";
block.example = "Test example";

builder.writeLine("My Test Example");
builder.writeLine(); // Empty Line
builder.writeObject(block);

builder.newBlock();
builder.writeLine("Test Block");

var comment = builder.toString();

--- Outputs

/**
 * My Test Example
 *
 * @param input {String} Input Parameter
 * @see http://www.google.com
 * @example Test Example
 **/

/**
 * Test Block
 **/

```

---
_Source: https://npm.io/package/comment-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._