Qodo Documentation
HomepageBlogCommunityGet Started
  • Overview
  • Qodo Gen
  • Qodo Portal
  • Administrators Actions
  • Introduction
  • Quickstart
  • Setup and Installation
    • VSCode Installation
    • JetBrains Installation
    • Sign In
    • Extension Settings
    • Uninstall
  • Qodo Gen Chat
    • Agentic Mode
      • Agentic Tools (MCPs)
      • Built-in Tools (MCPs)
    • Standard Mode
      • Focus
        • Current File Focus
        • Git Diff Focus
      • Context
        • Add Entire Folder or Project as Context
        • Add Image as Context
      • Commands
        • /ask
        • /changelog
        • /commit
        • /describe
        • /docstring
        • /enhance
        • /explain
        • /find-on-github
        • /generate-best-practices
        • /help
        • /improve
        • /issues
        • /recap
        • /review
    • Inline Context
    • Chat History
    • Model Selection
    • Chat Preferences
  • Company Codebase (RAG)
    • Tagging
    • Configuration File
  • Code Completion
  • Test Generation
    • Configuring Your Test Setup
  • Data Sharing
  • Release Notes
Powered by GitBook
LogoLogo

Terms and Privacy

  • Terms of Use
  • Privacy Policy
  • Data Processing

© 2025 Qodo. All Rights Reserved.

On this page
  • Using /docstring
  • Example

Was this helpful?

  1. Qodo Gen Chat
  2. Standard Mode
  3. Commands

/docstring

Last updated 2 months ago

Was this helpful?

/docstring generates or improves docstrings.

Use it to enhance documentation quality and maintainability by creating clear and consistent docstrings for functions, classes and modules.

Using /docstring

  1. Open a file: Open a file in your project.

  2. Activate Qodo Gen: Click the Qodo Gen logo in the Extensions bar.

  3. Focus: Select the part of the code you want to get a docstring for. It could be a few lines of code, a method, an entire file and more. Check out to learn more.

  4. Call the Command: Type /docstring in the chatbox and hit the send key or click the arrow button.

  5. (Optional) Add optional instructions: You can give Qodo Gen any specific guidelines.

  6. Result! Qodo Gen will analyze the selected code and generate a suitable docstring, or suggest improvements to existing documentation.

  7. (Optional) Continue your chat: To give Qodo Gen more instructions, just type a command or ask a question to keep chatting.

Example

Command

/docstring [optional instructions]

Response

[ docstring tailored for your code. ]
docstring generation example
our Focus documentation