Dev Tools

IDE

TM:PE is written in C# and requires an IDE such as Visual Studio or Rider.

We use the latest language version and target .NET Framework 3.5 (what C:SL uses, sorry).

Due to the size of the project, we use various analysers and style guides to avoid common mistakes and ensure consistency of formatting. Your IDE should automatically install any required items and show warnings inline and when building. If there are conflicting code style guidelines in your IDE, favour those generated by StyleCop.

• Rider - Remember to activate Roslyn Analyzers (why?)
• Visual Studio - You'll need VS 2019 or later (why?)
  • You can perform code review directly from Visual studio. see Reviewing pull request using Visual studio

Decompilers:

dnSpy

.NET browser and decompiler. Also useful for debugging. Requires manual install:

• dnSpy-net472.zip : https://github.com/0xd4d/dnSpy/releases
• Visual Studio plugin

ILSpy

.NET browser and decompiler. Requires manual install:

• icsharpcode/ILSpy
• Standalone tool
• Visual Studio plugin

dotPeek

.NET browser and decompiler. Requires manual install if not using Rider:

• Standalone tool

Roslyn Clr Heap Allocation Analyzer

Roslyn based C# heap allocation diagnostic analyzer that can detect explicit and many implicit allocations like boxing, display classes a.k.a closures, implicit delegate creations, etc. Requires manual install:

• microsoft/RoslynClrHeapAllocationAnalyzer
• Rider plugin
• Visual Studio plugin

ReflectionIT.Analyzer.Structs

Prevents use of in for anything other than readonly struct (why?).

• Automatically installed via NuGet.