Add string.Format analyzer to IDiagnosticLogger.Log methods

[jamescrosswell]

Originally posted by @bruno-garcia in #3923 (comment)

See issue #3922

Basically someone (yeah, OK, it was me) accidentally used the wrong index in the format string when calling LogDebug.

As Bruno points out, we should use an analyzer to prevent this happening in the future, since it could crash the user's application.

Solutions

We could quickly enable this for JetBrains IDEs like so:

• Code analysis in custom string formatting methods

[Flash0ver]

Since net7.0 there is now new Attribute for code highlighting in the IDE:

[System.Diagnostics.CodeAnalysis.StringSyntaxAttribute(System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.CompositeFormat)]

But I believe this is only about rendering in the IDE ... not producing diagnostics.