Codist icon indicating copy to clipboard operation
Codist copied to clipboard

Suggestion: Analyzer for Tagged comments

Open fitdev opened this issue 4 years ago • 4 comments

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 avatar Aug 19 '21 06:08 fitdev

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)

fitdev avatar Sep 30 '21 11:09 fitdev

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

fitdev avatar Jul 12 '22 13:07 fitdev

Aren't they already in the Task List?

image

wmjordan avatar Jul 13 '22 00:07 wmjordan

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

fitdev avatar Jul 13 '22 06:07 fitdev