huncholanevscode extension to make comments on the right of text line up
| 1 | # Comment Aligner |
| 2 | |
| 3 | The "Comment Aligner" extension for Visual Studio Code helps you align comments in your code for better readability and consistency. |
| 4 | |
| 5 | ## Features |
| 6 | |
| 7 | - Automatically aligns comments in your code based on the longest line before the comment delimiter. |
| 8 | - Supports multiple programming languages with different comment delimiters. |
| 9 | - Configurable number of spaces before the comment delimiter. |
| 10 | |
| 11 | ## Requirements |
| 12 | |
| 13 | No additional requirements or dependencies are needed for this extension. |
| 14 | |
| 15 | ## Extension Settings |
| 16 | |
| 17 | This extension contributes the following settings: |
| 18 | |
| 19 | - `comment-aligner.spacesBeforeComment`: Number of spaces to add before the comment delimiter. Default is `1`. |
| 20 | |
| 21 | ## Usage |
| 22 | |
| 23 | 1. Open a file in Visual Studio Code. |
| 24 | 2. Select the lines of code you want to align comments for. |
| 25 | 3. Use the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and type `Format Comments` to run the command. |
| 26 | 4. Alternatively, you can use the keyboard shortcut `Alt+A Alt+C` to quickly format comments. |
| 27 | |
| 28 | ## Known Issues |
| 29 | |
| 30 | - The extension currently supports a limited set of programming languages. If you need support for additional languages, please open an issue or contribute to the project. |
| 31 | |
| 32 | ## Release Notes |
| 33 | |
| 34 | ### 1.0.0 |
| 35 | |
| 36 | - Initial release of Comment Aligner. |
| 37 | |
| 38 | ## Contributing |
| 39 | |
| 40 | Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on the [GitHub repository](https://github.com/your-repo/comment-aligner). |
| 41 | |
| 42 | ## License |
| 43 | |
| 44 | This project is licensed under the MIT License. |
| 45 | |
| 46 | ## For more information |
| 47 | |
| 48 | - [Visual Studio Code's Extension API](https://code.visualstudio.com/api) |
| 49 | - [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
| 50 | - [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
| 51 | |
| 52 | **Enjoy!** |