Use Annotations to Refine Code Inspection
Code inspection and many other ReSharper features largely rely on knowing behavior of language constructs to detect issues, suggest possible improvements, and help you in other ways.
However, this kind of analysis cannot detect everything. For example, if a method is designed to never return
null and its clients are designed accordingly, no structural analysis will find a possible issue if someone has changed the method to return
In this and a lot of other cases, the ReSharper's
JetBrains.Annotations is of a great help. By using attributes declared in this framework you can make ReSharper analyze code the way you need it. For example:
This being the simplest example, there are other helpful attributes with more complex use cases. You can find the full list of these attributes in the reference.
In most cases, code annotation attributes enable specific code inspections, for example:
StringFormatMethodAttributehelps detect misuses of string formatting methods.
NotNullAttributeare associated with the Possible 'null' assignment to entity marked with 'Value cannot be null' attribute. For more information, see Value and Nullability Analysis.
CannotApplyEqualityOperatorAttributeis bound to the Code Inspection: Compare with '==' types marked by 'CannotApplyEqualityOperatorAttribute'.
ContractAnnotationAttributecan be used to define contracts for your functions and turn on the corresponding inspections. For example, you can use
[ContractAnnotation("input:null => false")]to notify the consumers of the function
bool Foo(object input)that always returns
Also, code annotations enable more quick-fixes, code completion suggestions, and code generation features on annotated items. The annotations are also required to create and use Source Templates.
ReSharper allows you to annotate code symbols in two ways:
You can annotate symbols in your source code as shown in the example above. In this case, you need to reference
JetBrains.Annotationsnamespace in your project. For more information, see Annotations in Source Code.
Even if you do not have access to sources, you can annotate symbols in compiled library code. For more information, see External Annotations.
This feature is supported in the following languages and technologies:
The instructions and examples given here address the use of the feature in C#. For details specific to other languages, see corresponding topics in the ReSharper by Language section.