Describes the interface for the code coverage data exposed by mono.
Use one of the following methods to enable coverage:
1) Use the Coverage.enabled API
2) Use the Command line argument -enableCodeCoverage
in batchmode
Code Coverage is a measure of how much of your code has been executed. It is normally associated with automated tests, but you can gather coverage data in Unity at any time when the Editor is running. It is typically presented as a report that shows the percentage of the code that has been executed. For automated testing the report does not measure the quality of tests, only whether your code is executed by PlayMode and EditMode tests. It is especially useful to check that critical or high risk areas of your code are covered, because they should receive the most rigorous testing.
You can use the Code Coverage package to gather and present code coverage information from your automated tests. Additionally, the Code Coverage package offers a Coverage Recording feature which allows capturing coverage data on demand, for manual testing or when there are no automated tests in the project.
Note that in Unity 2019 and 2020 you can enable Code Coverage in General Preferences. This was removed in Unity 2021; the user interface for managing Code Coverage is now entirely inside the Code Coverage package.
enabled | Enables or disables code coverage. Note that Code Coverage can affect the performance. |
GetSequencePointsFor | Returns the coverage sequence points for the method you specify. See CoveredSequencePoint for more information about the coverage data this method returns. |
GetStatsFor | Returns the coverage summary for the specified method. See CoveredMethodStats for more information about the coverage statistics returned by this method. |
GetStatsForAllCoveredMethods | Returns the coverage summary for all methods that have been called since either the Unity process was started or Coverage.ResetAll() has been called. |
ResetAll | Resets all coverage data. |
ResetFor | Resets the coverage data for the specified method. |
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.