Skip to content

UnityContrib/code-analysis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 

Repository files navigation

code-analysis

Roslyn code analyzers

What does it do?

Basicly it generates compiler warnings and errors specific to Unity code.

The idea is to have a few rules that ensures a good level of quality code. E.g. if a field is visible in the Unity inspector, it must have a tooltip attribute describing what it does, what it is used for or allowed values.

Current Rules

ID Description Has Code Fixer
UCHasTooltip Requires private instance fields marked with [SerializeField] attribute to also have a [ToolTip] attribute when the class derrives from MonoBehaviour. YES
UCNonEmptyTooltip All [Tooltip] attributes are not allowed to have an empty string. NO
UCPrivateField All fields on MonoBehaviours must be private. YES

Releases

No releases published

Packages

No packages published