https://github.com/slamko/yield-at-me
A set of roslyn analyzers for convinient use of Unity coroutines
https://github.com/slamko/yield-at-me
cleancode codefix coroutines csharp roslyn-analyzers unity
Last synced: 26 days ago
JSON representation
A set of roslyn analyzers for convinient use of Unity coroutines
- Host: GitHub
- URL: https://github.com/slamko/yield-at-me
- Owner: slamko
- Created: 2021-10-29T09:58:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-16T18:36:14.000Z (over 4 years ago)
- Last Synced: 2025-09-05T07:42:39.769Z (9 months ago)
- Topics: cleancode, codefix, coroutines, csharp, roslyn-analyzers, unity
- Language: C#
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A set of roslyn analyzers for convinient use of ***Unity coroutines***
#### This package was designed to help to prevent you from common issues when using unity coroutines.
### [Nuget Package](https://www.nuget.org/packages/UnityCoroutinesAnalyzer/1.0.3.5)
## Analyzers
### **1. Coroutine invocation analyzer**
As You know there is few ways to start a coroutine in unity:
- Passing coroutine name:
```csharp
StartCoroutine("Coroutine");
IEnumerator Coroutine() {}
```
- Executing coroutine method:
```csharp
StartCoroutine(Coroutine());
IEnumerator Coroutine() {}
```
> #### Problems
Using the first one it is easy to make a mistake in coroutine name when writing string literal.
And if you would use the second one, you won't be able to stop the coroutine. Because you are creating an independent coroutine instance.
> #### Solution
- The first analyzer encourages you to start the coroutine using 'nameof' syntax:
```csharp
StartCoroutine(nameof(Coroutine));
IEnumerator Coroutine() {}
```
So now you are able to call 'StopCoroutine' method with the expected result and avoid excessive mistakes.
### **2. Yield return in `while(true)` block**
Coroutines in Unity are often used in combinations with `while(true)` block:
```csharp
IEnumerator Coroutine()
{
while(true)
{
...
}
}
```
> #### Problems
Although it is easy to forget to put `yield return` statement inside `while(true)` (that leads to Unity crash),
Visual Studio doesn't have any embedded analyzers that prevents you from such troubles. So the code above won't trigger any Visual Studio warnings or recommendations.
> #### Solution
Code analyzers in this package would warn you about possible issues and suggest to put `yield return null;` on the end of `while` block:
```csharp
IEnumerator Coroutine()
{
while(true)
{
...
yield return null;
}
}
```