Visual Studio Marketplace
marketplace.visualstudio.com › items
autoDocstring: VSCode Python Docstring Generator
Extension for Visual Studio Code - Generates python docstrings automatically
Visual Studio Marketplace
marketplace.visualstudio.com › items
AI Python Docstring Generator - Visual Studio Marketplace
November 19, 2020 - Extension for Visual Studio Code - Automatically generates summary for python functions using AI
No More Python Docstring Despair: Highlight Them in VSCode!
What happens when you start a string with a double quote instead of single quotes? More on reddit.com
8
21
March 12, 2024Python Visual Studio Code autoDocstring Configuration - Stack Overflow
Goal: generate docstring in vscode for Python automatically and format the generated docstring to my liking. Solution: I installed the autoDocstring extension. Problem: I don't know how to get the More on stackoverflow.com
AI written docstrings for your Python code
Plans to add to Pycharm ? :) great job so far ! Extentions for lazy people are always great ! More on reddit.com
29
46
January 22, 2022What is the "working" Python docstring style for VS Code tooltips?
I think I see what you mean. It doesn't really answer your question, but here are a couple considerations that can make your life easier in the meantime: I wanted to make the docstrings more legible in the code. I used the extension Highlight to write ugly regexes to match specific characters in a Google-style docstring, to make it more legible, like so . Instead of relying on tooltips, you can rely on another nice feature of VS Code: Peek Definition. It allows you to look to another location in the code in-place. It's a nice way to quickly see what a function does somewhere else in the code. You can bind this operation to a keybind of your liking to do that efficiently. I also recommend using the autoDocstring extension, which works nice. I wrote a custom mustache template to remove types from the Google template, as I rely on the extension sphinx_autodoc_typehints to generate them from my type hints. More on reddit.com
2
3
March 11, 2020GitHub
github.com › graykode › ai-docstring
GitHub - graykode/ai-docstring: Visual Studio Code extension to quickly generate docstrings for python functions using AI(NLP) technology. · GitHub
Visual Studio Code extension to quickly generate docstrings for python functions using AI(NLP) technology. This project is forked for NilsJPWerner/autoDocstring.
Author: graykode
Visual Studio Marketplace
marketplace.visualstudio.com › items
ChatGPT: Docstring Generator - Visual Studio Marketplace
Extension for Visual Studio Code - Automatically generate Python docstrings using ChatGPT.
Python Engineer
python-engineer.com › posts › vscode-python-setup
My Minimal VS Code Setup for Python - 5 Visual Studio Code Extensions - Python Engineer
Visual Studio Code extension to quickly generate docstrings for python functions.
GitHub
github.com › NilsJPWerner › autoDocstring
GitHub - NilsJPWerner/autoDocstring: VSCode extension that generates docstrings for python files · GitHub
Visual Studio Code extension to quickly generate docstrings for python functions.
Author: NilsJPWerner
Visual Studio Marketplace
marketplace.visualstudio.com › items
Python DocString Generator AI - Visual Studio Marketplace
March 18, 2021 - Extension for Visual Studio Code - Python docstring generator, for functions, based on deep learning model, configurable.
Towards Data Science
towardsdatascience.com › home › latest › 3 easy steps to folding docstrings in vscode
3 Easy Steps to Folding Docstrings in VSCode | Towards Data Science
January 23, 2025 - Programmers using VSCode should add "docstrings" to their projects which generate the documentation for users of the code to read when they hover over it in VSCode or press Shift-Tab in Jupyter notebooks. Programmers can also use extensions to auto-generate the docstring skeletons to save time, for instance, the excellent Python Docstring Generator which can be obtained here - https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring.
Microsoft Developer Blogs
devblogs.microsoft.com › dev blogs › microsoft for python developers blog › python in visual studio code – november 2024 release
Python in Visual Studio Code - November 2024 Release - Microsoft for Python Developers Blog
November 1, 2024 - You can generate a docstring template for classes or methods by typing """ or ''', pressing kbstyle(Ctrl+Space), or selecting the lightbulb to invoke the Generate Docstring Code Action.
Python How Tos
campbell-muscle-lab.github.io › howtos_Python › pages › documentation › best_practices › vscode_docstring_extension › vscode_docstring_extension.html
Visual Studio Docstring Extension - Python How Tos
To automatically insert the docstring with proper formatting, you type three quotes, """ like a normal docstring, then hit Enter to let the extension automatically format the docstring.
CopyAssignment
copyassignment.com › python-docstring-generator-pycharm-and-vscode
Python Docstring Generator | PyCharm And VsCode
Disclaimer: References to any specific company, product or services on this Site are not controlled by GoDaddy.com LLC and do not constitute or imply its association with or endorsement of third party advertisers
Legendu
legendu.net › misc › blog › Python-Docstring-Generator-for-vscode
Python Docstring Generator for Visual Studio Code
July 30, 2020 - The extension Python Docstring Generator is recommended.
Reddit
reddit.com › r/vscode › no more python docstring despair: highlight them in vscode!
r/vscode on Reddit: No More Python Docstring Despair: Highlight Them in VSCode!
March 12, 2024 -
Hey everyone!
I'm excited to share a simple yet effective tool I've developed that's all about enhancing your Python coding experience in VSCode. We all know how Docstrings are crucial for understanding and documenting our Python code, but they often blend into the background, treated as standard comments in VSCode. This can make them harder to read and differentiate from the rest of your code.
That's why I created a Python Docstring Highlighter for VSCode that recognizes the main styles (Google, NumPy, and Sphinx). This extension not only makes your code more readable but also allows you to customize the highlighting to fit your theme, making your coding environment as comfortable and productive as possible.
Python Docstring Highlighter Demo (google style)Whether you're documenting your own project or navigating through others', this extension is designed to make your life easier and your code more accessible. Give it a try and see the difference for yourself!
Source code
Install extension (VSCode)
Looking forward to your feedback and suggestions. Happy coding!
Towards Data Science
towardsdatascience.com › home › latest › how to generate docstrings for data science projects
How to Generate Docstrings for Data Science Projects | Towards Data Science
January 22, 2025 - ... We will be using the default Google docstring format for the rest of the examples. Let's write a simple function to add two integer values. ... To generate the docstring, place the cursor in the line directly below the function definition (i.e.
GitHub
github.com › aijurist › python-docstring-generator
GitHub - aijurist/python-docstring-generator: VS Code extension for generating docstrings for python functions, classes and modules
VS Code extension for generating docstrings for python functions, classes and modules - aijurist/python-docstring-generator
Author: aijurist
GitHub
github.com › aijurist › Docstring-Generator-for-Python
GitHub - aijurist/Docstring-Generator-for-Python: VS Code extension for generating docstrings for python functions, classes and modules · GitHub
Generate docstrings for Python functions with a single click or keyboard shortcut · Automatically detects function parameters, return types, and potential exceptions · Creates properly formatted docstrings following PEP-257 standards · Works entirely within VSCode - no external API calls needed
Author: aijurist
Top answer 1 of 2
21
You have to go to:
File > Preferences > Settings in Windows/Linux
Code > Preferences > Settings in Mac
Then choose at the right side of the open document if you want to change the configuration for all the user sessions or only this workspace.
The workspace case would be:
{
"autoDocstring.docstringFormat": "sphinx"
}
When moving the mouse around the option, a little pencil appears that shows all the accepted values for the option.
2 of 2
0
This answer is almost the same as PyCharm generates on vscode with this shortcut ctrl+sfhit+2
{
"autoDocstring.docstringFormat": "sphinx"
}
Visual Studio Marketplace
marketplace.visualstudio.com › items
python docstrings - Visual Studio Marketplace
Extension for Visual Studio Code - generate python docstrings for classes and methods
YouTube
youtube.com › watch
Auto DocString Extension || Visual Studio Code - YouTube
Auto DocString Extension is installed in Visual Studio Code
Published: June 27, 2022
Towards Data Science
towardsdatascience.com › home › latest › step by step basics: code autodocumentation
Step by Step Basics: Code Autodocumentation | Towards Data Science
January 24, 2025 - Top tip. download the 'autoDocstring - Python Docstring Generator' in VS Code to automatically generate a docstring when you type three double quotation marks (i.e. the start of a docstring).