Describes the interface for the code coverage data exposed by mono.
Use one of the following methods to enable coverage:
1) Enable Code Coverage in General Preferences
2) Use the Coverage.enabled api
3) Use the Command line argument -enableCodeCoverage
in batchmode
Code Coverage is a measure of how much of your code is executed when you run automated tests. It is typically presented as a report that shows the percentage of your code that is covered by tests.
It is much easier to accidentally introduce bugs into code that is not covered by tests, because those bugs are not detected straight away by the tests and can instead cause problems later — such as after you have published your game or app.
The report does not measure the quality of tests, only whether your code is executed at all 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.
To generate a code coverage report you can install the Code Coverage package, which is a client of the Coverage api.
enabled | Enables or disables code coverage collection. Note that Code Coverage lowers Editor 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.