explained
Description
Explained, a Visual Studio Code extension that generates comments summarizing your selected code, aiding comprehension for others.
Installation
- Open Visual Studio Code.
- Go to the Extensions view (Ctrl + Shift + X).
- Search for "Explained".
- Click on the Install button to install the extension.
Usage
- Select a portion of your code that you want to generate a comment for.
- Press Ctrl + Shift + P to open the Command Palette.
- Type "Comment it" and run the command. A comment summarizing your selected code will be inserted at the start of the selection.
- Supporting: JavaScript, TypeScript, Python, HTML, CSS, Java, C, C++, Go, Ruby, PHP, Swift, Rust, XML, SQL, Perl, Lua, R, Scala, Groovy, Kotlin, Dart, Fortran; and soon, more.
Additional Features
You can choose how many comments you want to generate:
- Press Ctrl + Shift + P to open the Command Palette.
- Type "Comment amount" and run the command.
- Enter the number of comments you want to generate (1, 2, or 3). The extension will remember your choice and generate that number of comments the next time you use the "Comment it" command.
Feedback and Contributions
All constructive feedback and suggestions for improvement are welcome! If you have any bug, or you have an idea for a new freature, you could open an issue on the GitHub repository. Thank you!
| |
