irongit

vscode extension to make comments on the right of text line up

52 lines1.8 KBMarkdown

Comment Aligner

The "Comment Aligner" extension for Visual Studio Code helps you align comments in your code for better readability and consistency.

Features

  • Automatically aligns comments in your code based on the longest line before the comment delimiter.
  • Supports multiple programming languages with different comment delimiters.
  • Configurable number of spaces before the comment delimiter.

Requirements

No additional requirements or dependencies are needed for this extension.

Extension Settings

This extension contributes the following settings:

  • comment-aligner.spacesBeforeComment: Number of spaces to add before the comment delimiter. Default is 1.

Usage

  1. Open a file in Visual Studio Code.
  2. Select the lines of code you want to align comments for.
  3. Use the command palette (Ctrl+Shift+P or Cmd+Shift+P on Mac) and type Format Comments to run the command.
  4. Alternatively, you can use the keyboard shortcut Alt+A Alt+C to quickly format comments.

Known Issues

  • 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.

Release Notes

1.0.0

  • Initial release of Comment Aligner.

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on the GitHub repository.

License

This project is licensed under the MIT License.

For more information

Enjoy!