Use Roslyn analyzers, source generators and ruleset files in Unity projects to inspect your code for style, quality, and other issues.
You can use existing analyzer libraries to inspect your code, and write your own analyzers to promote the best practices or conventions within your organization.
Note: Roslyn analyzers are only compatible with the IDEs that Unity publicly supports, which are Visual Studio and JetBrains Rider.
For more information about how to write and use Roslyn analyzers, refer to Microsoft’s Analyzer Configuration and Get started with Roslyn analyzers documentation.
Topic | Description |
---|---|
Create and use a source generator | Create a simple source generator and configure the Unity Editor to use it for your Unity project code. |
Install and use an existing analyzer or source generator | Download an existing code analyzer or source generator and configure the Unity Editor to use it for your Unity project code. |
Additional files for Roslyn analyzers and source generators | Define additional text files for Roslyn analyzers or source generators to use. |
Create rule set files | Create rule sets to customize the standards your code analysis tools enforce. |
Code analyzer scope and diagnostics | Control which parts of your code are subject to code analysis and get insights into how long analysis is taking. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.