Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add square-brackets-references to comments to refer to other types #248

Open
ilka-schulz opened this issue Feb 29, 2024 · 0 comments
Open

add square-brackets-references to comments to refer to other types #248

ilka-schulz opened this issue Feb 29, 2024 · 0 comments
Labels
code-quality Reviews or improves code quality maintenance Part of maintenance activities

Comments

@ilka-schulz
Copy link
Contributor

  1. It makes the comment more readable.
  2. IDEs like VS Code insert clickable hyperlinks into the rendered comment which makes skimming the code base much easier.
@prabhpreet prabhpreet added maintenance Part of maintenance activities code-quality Reviews or improves code quality labels May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code-quality Reviews or improves code quality maintenance Part of maintenance activities
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@prabhpreet @ilka-schulz