Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.19 KB

faq.md

File metadata and controls

26 lines (16 loc) · 1.19 KB
Raw
title nav_order
FAQ
6

Q: Why is this project called Style as Code?

A: Similar to Infrastructure as Code, Style as Code is meant to help manage coding style through versioned EditorConfig files.

Also:

var goodName = style as Code;

Q: What are Roslyn Analyzers?

A: A key part of implementing code style best practices is Roslyn Analyzers. These convert EditorConfig settings and theoretical best practices to the squiggles and suggestions shown in your IDE.

Many analyzer packages exist, each containing multiple rules (also known as diagnostics). One goal of this project is to map analyzer rules to best practice pages that discusses their usage.

This allows developers to easily search by rule IDs (e.g. IDE0003) to find the best practices information on that subject.

Q: Should I use code analysis or EditorConfig for checking code style?

See the Microsoft Docs on this question.