Is there an automatic code formatter for C#?

C#FormattingBuild Automation

C# Problem Overview

In my work I deal mostly with C# code nowadays, with a sprinkle of java from time to time. What I absolutely love about Eclipse (and I know people using it daily love it even more) is a sophisticated code formatter, able to mould code into any coding standard one might imagine. Is there such a tool for C#? Visual Studio code formatting (Crtl+K, Crtl+D) is subpar and StyleCop only checks the source without fixing it.

My dream tool would run from console (for easy inclusion in automated builds or pre-commit hooks and for execution on Linux + Mono), have text-file based configuration easy to store in a project repository and a graphical rule editor with preview - just like the Eclipse Code Formatter does.

C# Solutions

Solution 1 - C#

For Visual Studio, take a look at ReSharper. It's an awesome tool and a definite must-have. Versions after 4.0 have the code formatting and clean-up feature that you are looking for. There's also plugin integration with StyleCop, including formatting settings file.

You'll probably want Agent Smith plugin as well, for spell-checking the identifiers and comments. ReSharper supports per-solution formatting setting files, which can be checked into version control system and shared by the whole team. The keyboard shortcut for code cleanup is Ctrl + E, C.

In 'vanilla' Visual Studio, the current file can be automatically formatted with Ctrl + K, Ctrl + D, and Ctrl + K, Ctrl + F formats the selected text.

As for a runs-everywhere command line tool to be used with commit hooks, try NArrange. It's free, can process whole directories at once and runs on Mono as well as on Microsoft .NET.

Some people also use the Artistic Style command line tool, although it requires Perl and works better with C/C++ code than with C#.

Solution 2 - C#

The .NET Foundation just released their code formatting tool on GitHub

https://github.com/dotnet/codeformatter

It uses the Roslyn compiler services to parse project documents and convert them to their expected formatting conventions. They're applying this to some of the very old CLR code in order to make all the projects consistent.

Solution 3 - C#

Further to @Chris Karcher's answer - you can also automatically format the whole document by hitting Ctrl+K, Ctrl+D.

These formatting features work on a variety of file formats - it works wonders on ugly HTML.

Solution 4 - C#

Another option: NArrange;

  • free
  • console based (so good for commit hooks etc, but can still be used as an "External Tool" in VS)
  • flexible config file

Solution 5 - C#

For me, Ctrl + Shift + F maps to Find in Files. When I need to format code, I highlight it and hit Ctrl + K, Ctrl + F.

I understand this doesn't really address automated formatting. I just wanted to clarify for those who may not know this feature even exists in Visual Studio.

Solution 6 - C#

I've heard only good things about ReSharper. It's on my to-learn list.

Solution 7 - C#

http://www.sourceformat.com/

This tool is around (~30$). I tried it and it works nice (with multiple languages).

I like this tool the best because it doesn't check code file for correctness. I can post code snippets from the Internet and it will translate them correctly no matter if they are in missing parts of the code. Other tools I try complain in that cases. The tool can also be integrated easily into editors as it allows command line driving.

Other tools:

http://www.polystyle.com/index.jsp

http://astyle.sourceforge.net/ (open source)

Solution 8 - C#

Not directly, but I use the Agent Smith plugin for R# to do this. Unfortunately, R# isn't free.

Solution 9 - C#

Also take a look at Microsoft StyleCop

Solution 10 - C#

I haven't tried this (found it through Google). It might work. http://www.semdesigns.com/Products/Formatters/CSharpFormatter.html. It's fairly cheap at USD50, but a trial is not available.

Solution 11 - C#

See this previous question:

Is there any tool for reformatting C# code?

Searching for [c#] astyle shows up some more previous questions too.

Solution 12 - C#

Maybe you could be interested in this free Addin for Visual Studio 2010/2012.

Solution 13 - C#

Here is an open source code formatting tool which has amazing features

CodeMaid

Solution 14 - C#

If you want to do it online, have a freecodeformat.

Categories
Recommended C# Solutions
Recommended Formatting Solutions
Recommended Build Automation Solutions

Previous Solution:

Factorial Algorithms in different languages

AlgorithmLanguage Agnostic

Next Solution:

Where is the console API for WebKit/Safari?

JavascriptConsoleSafari

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionskolimaView Question on Stackoverflow
Solution 1 - C#FantaMango77View Answer on Stackoverflow
Solution 2 - C#Paul TurnerView Answer on Stackoverflow
Solution 3 - C#Ian NelsonView Answer on Stackoverflow
Solution 4 - C#Marc GravellView Answer on Stackoverflow
Solution 5 - C#Chris KarcherView Answer on Stackoverflow
Solution 6 - C#Zack PetersonView Answer on Stackoverflow
Solution 7 - C#majkinetorView Answer on Stackoverflow
Solution 8 - C#JamesSugrueView Answer on Stackoverflow
Solution 9 - C#SQLMenaceView Answer on Stackoverflow
Solution 10 - C#JanView Answer on Stackoverflow
Solution 11 - C#Simon SteeleView Answer on Stackoverflow
Solution 12 - C#NinjaCrossView Answer on Stackoverflow
Solution 13 - C#VikramView Answer on Stackoverflow
Solution 14 - C#Alexandre NascimentoView Answer on Stackoverflow