ts-simple-ast/docs/details/documentation.md

TypeScript compiler wrapper for AST navigation and code generation.

---

title: JS Docs
---


## JS Docs

Certain nodes in TypeScript can have JS docs. For example:

```typescript
/**
 * Gets the name.
 */
function getName() {
    // ...
}
```

### Get string

Use `getDocumentationComment()` to return all the documentation comments separated by new lines as a string:

```typescript
functionDeclaration.getDocumentationComment(); // returns: string | undefined
```

This will return `undefined` if no documentation comment exists.

### Get all documentation comment nodes

Get all the documentation comment nodes by using `getDocumentationCommentNodes()`:

```typescript
functionDeclaration.getDocumentationCommentNodes(); // returns: JSDoc[]
```

### Add/insert docs

Add or insert documentation comments using the `addDoc()`, `addDocs()`, `insertDoc()`, and `insertDocs()` methods.

For example:

```typescript
const docNode = classDeclaration.addDoc({
    description: "Some description..."
});
```

Right now you can only add a description, but in the future support will be added for easily manipulating more JS doc syntax.