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.

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

Suggestion: Analyzer for Tagged comments #174

Open
fitdev opened this issue Aug 19, 2021 · 4 comments
Open

Suggestion: Analyzer for Tagged comments #174

fitdev opened this issue Aug 19, 2021 · 4 comments

Comments

@fitdev
Copy link

fitdev commented Aug 19, 2021

It would be nice to be able to have some user-defined comment tags participate in code analysis, such that certain tagged comments can produce either warnings or errors.

So, at the basic level, a 3rd dropdown is needed on tags section in the Syntax Highlight Configurations called Analyzer (or something similar) with values:

  • None: Does not participate in code analysis at all
  • Warning: If tag is present a compiler warning is issued
  • Error: If tag is present, it's a compile time error

Maybe for Warning and Error add ability to define custom, per-tag analyzer IDs.

A More Advanced Version:

To make this even more useful, whether or not a Warning/Error is issued can be made to depend on not just on the comment tag itself (string value), but on additional conditions:

  • Project configuration / compile time #constant
  • Date - to enable reminders / todo-like functionality

To implement it as an Analyzer in an extension, you can look into how they do analyzers in Roslynator

@fitdev
Copy link
Author

fitdev commented Sep 30, 2021

Additional Ideas about Tagged Comments:

  1. Ability to list / display such tagged comments in the NaviBar's dropdowns:
  • Current File Node (first item)
  • Respective place within the namespace / type drodowns
  1. Ability to display these in Super QuickInfos (perhaps in a similar place where Analyzer comment is displayed)

@wmjordan wmjordan added this to the Backlog milestone Sep 30, 2021
@fitdev
Copy link
Author

fitdev commented Jul 12, 2022

Another possibility is to perhaps somehow integrate it with VS's task list.

@wmjordan
Copy link
Owner

Aren't they already in the Task List?

image

@fitdev
Copy link
Author

fitdev commented Jul 13, 2022

You are right! Sorry about that. I guess I forgot to keep the 2 lists in sync (I have more comment tags defined in Codist than I have defined in VS's task list).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants