Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
switer committed Oct 6, 2013
1 parent 173005b commit 26c2baf
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.md
Expand Up @@ -26,7 +26,7 @@ And use with `var comment = require("comment")`

## API

### module method
### Module function

```javascript
comment.single("comment text");
Expand All @@ -38,13 +38,13 @@ Return a single line comment string
comment.block("comment text");
/* comment text */
```
Return a normal block comment string:
Return a normal block comment string

```javascript
comment.title("comment text");
/***** comment text *****/
```
Return a block comment string like comment title:
Return a block comment string like comment title

```javascript
comment.banner("comment text\nhello world");
Expand All @@ -53,5 +53,28 @@ comment.banner("comment text\nhello world");
* hello world
**/
```
Return a banner block comment string:
Return a banner block comment string

### Prototype function

```javascript
"comment text".single();
// comment text

"comment text".block();
/* comment text */


"comment text".title();
/***** comment text *****/


"comment text".banner();
/**
* comment text
* hello world
**/

```


0 comments on commit 26c2baf

Please sign in to comment.