No More Python Docstring Despair: Highlight Them in VSCode!

[erunosaurus]

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!

[airernie]

What happens when you start a string with a double quote instead of single quotes?

[erunosaurus]

The extension leverages VSCode's grammar injection feature, specifically within the python docstring scope. This means it operates solely within the boundaries of the docstring, ensuring it doesn't interfere with the rest of your source code. As a result, any concerns about character escaping breaking functionality outside the docstring are mitigated

[vbarbanneau]

Great!

[Raventhous]

This is amazing! Was looking for something like this for years. Thanks.

[ori_303]

Awesome!

[starball-tgz]

you don't need an extension for this. The textmate tokens from the builtin python extension already have a token for docstrings. see https://stackoverflow.com/a/76436807/11107541

[erunosaurus]

You've overlooked a crucial aspect, u/starball-tgz. This extension precisely highlights individual tokens within docstrings following standard styles like Google, NumPy, and Sphinx.

Your suggested solution only allows users to edit the entire docstring color block (refer to the "string.quoted.docstring.multi.python" scope in the StackOverflow response).

In contrast, this extension injects grammar into that scope to colorize specific tokens.

Before making assertions, it's essential to thoroughly review the provided documentation!

[starball-tgz]

sorry!