Skip to main content
Version: 1.3.0

Autodoc

Using The Autodoc Feature​

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:

  • 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.

  • Right-click on the Coding file —> Select “Codevista” —> Select “Generate commends” as the below photo.

Command list.png

  • Review the generated docstrings/ comments on “Refactor Preview”

    Command list.png

    • Click to choose docstrings/ Comments want to review at number 1.
    • View the corresponding generated docstrings/ comment at number 2.

  • Apply or Discard docstrings/ comments.

    • Select docstrings/ comments (number 1 at the above image).
    • Click "Apply" to apply the selected options (number 3 at the above image) or
    • Click "Discard" to discard all.