The Comment Linker extension for Visual Studio Code allows you to create clickable links within comments in Python files. It enhances code documentation by providing an easy way to reference other files or locations in your codebase.
- Automatically detects and highlights links within comments in Python files.
- Supports both absolute and relative paths as links.
- Clicking on a link opens the corresponding file or location within Visual Studio Code.
- Launch Visual Studio Code.
- Go to the Extensions view (Ctrl+Shift+X).
- Search for "Comment Linker" and click Install.
- Reload Visual Studio Code to activate the extension.
-
Open a Python file in Visual Studio Code.
-
Write comments containing links using the following format:
[link description](link target)For example:
# Please see the [documentation](/path/to/documentation.md) for more information. -
Save the file. The links will be detected and highlighted automatically.
-
Hover over a link to view its description in a tooltip.
-
Click on a link to open the corresponding file or location within Visual Studio Code.
The Comment Linker extension does not require any additional configuration. It automatically detects and highlights links within comments in Python files.
- Currently, the extension only supports Python files.
- Links are only recognized within comments and not within other parts of the code.
If you encounter any issues, have suggestions, or would like to contribute to the Comment Linker extension, please visit the GitHub repository. Contributions, bug reports, and feature requests are welcome.
- Initial release of the Comment Linker extension.
This extension is released under the MIT License. See LICENSE for details.
Feel free to modify and expand upon this template to include more specific details about your extension, such as additional features, supported languages, or any customization options available.