Coding Guidelines

Coding guidelines

The HdrHistogram.NET is a .NET code base written in C# (6.0), with build scripts in PowerShell (5.0) and documentation in Markdown.

C# Guidance

Currently we use C# 6.0 and the default Resharper 10.0 VisualStudio rules. The target .NET framework is currently 4.5.2. Additional platform support is targeted by issue #17

Public members are expected to have XML comments added. Building in release mode will trigger warnings for missing comments.

Unit tests should be used to both verify and document code. Ideally Unit tests should act as examples of how to use the API. Running unit tests in relase mode will be significantly faster

PowerShell Guidance

We take the lead from The PowerShell Best Practices and Style Guide from PoshCode