Autodoc

This feature enables you to automatically generate docstrings and comments for your code using Autodoc. The tool will analyze your code and suggest appropriate comments.

To use this feature, please follow these steps:

1. Select code snippets that you want to generate docstring. You can pass this step if you want to generate docstring for the whole coding file.

2. Right-click on the Coding file —> Select CodeVista --> Generate Comments.

3. Preview the generated comments.

4. Accept or discard generated comments

Select docstrings/comments
Choose Apply to accept generated comments, or Discard to cancel.

The Autodoc feature supports a maximum input context of 16,000 tokens.

If your file or project exceeds this limit, you may need to document sections individually or reduce the scope of the input.

On this page

Autodoc