Generate Code Docs in VS Code¶

Overview¶

CloudAEye can generates code documentation saving developer time and ensuring code maintainability and readability. This guide explains how CloudAEye generates code documentation.

Generate Docs in GitHub¶

For generating docs in GitHub, refer to GitHub: Generate Code Docs page.

Prerequisites¶

Step 1: Setup Code Review¶

Configure Code Review.

Step 2: Setup VS Code Extension¶

Setup the VS Code Extension.

Generate Docs¶

To generate code docs for your connected repository, click on the Generate Docs button in the CloudAEye extension.

Demo GIF

Once the docs are generated a VS code diff viewer will open. This view will have all the new docs that are added. You can add/remove/edit the docs before saving it.