Save Time Writing Comments with AI

Readable is a VSCode extension which generates comments using GPT-3. It's fast, reliable, consistent, and saves you loads of time.

Works in 9 Languages

• Typescript
• Javascript
• JSX/TSX
• Python
• C
• C#
• C++
• Java
• PHP

Docstring Comments

To generate a docstring press ctrl ' (cmd ' on Mac) while your cursor is in any function OR if the function is highlighted.

Inline Comments

To generate an inline comment type // for C-Sytle languages. For python type #. After hitting space, press tab to generate an inline comment. Optionally, type a few words after // to generate a more specific comment.

Pricing

Start Readable with a 15 day free trial. After, purchase Readable for only $19.99 a year.

Privacy

Readable does not store or use your code to train any of its models.

Note: Read OpenAI's privacy policy if you are unsure about what they do.

Getting Set Up

Thanks for trying out Readable!

When you first install Readable, you will be prompted to log in or create an account. Readable supports two forms of authentication: GitHub login and email.

If you would like to enable/disable comment suggestions, then you can run "Readable: Enable Comment Suggestions", or "Readable: Disable Comment Suggestions" via the command palette.

Requirements

• VSCode
• An internet connection to generate comments

Extension Settings

You can configure the following settings:

• readable.enableAutoComplete: enable/disable comments

Known Issues

• Generate docstring (ctrl + ') on c# code does not work because the c# extension for VSCode has not been updated to work with the latest dotnet.

Release Notes

[1.5.5]

• Bug fixes

Contact

Feel free to email support@readable.so for any questions/comments you may have about Readable. The team reads all emails and will get back to you ASAP.

2022, Puri Chapman Software LLC