Dennysoft.Core.JsonDoc 1.1.0

.NET 8.0

dotnet add package Dennysoft.Core.JsonDoc --version 1.1.0

NuGet\Install-Package Dennysoft.Core.JsonDoc -Version 1.1.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Dennysoft.Core.JsonDoc" Version="1.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Dennysoft.Core.JsonDoc" Version="1.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Dennysoft.Core.JsonDoc" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Dennysoft.Core.JsonDoc --version 1.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Dennysoft.Core.JsonDoc, 1.1.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Dennysoft.Core.JsonDoc@1.1.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Dennysoft.Core.JsonDoc&version=1.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Dennysoft.Core.JsonDoc&version=1.1.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

JsonDoc

A simple way to create commented JSON documents for configuration purposes.

My intention was to create a tool for commenting json based configuration files. Json does not allow any commenting as a standard, but most of the serializers can work with some comments in the document. For configuration files it is essential to have some explanatory documentation over the parameters especially if the parameter set is large enough.I am using this technique for some time now, and I am very satisfied with the results. You can generate your default config file with an ease, and well commented for the operators.

Usage:

//definition

[JsonDoc("This is a class level doc A")]
public class BaseClassA
{
    [JsonDoc("This is a string property")]
    public string STRING { get; set; }
}

//somewhere in your code:
var doc = JsonDoc.ToDocumentedJson(new BaseClassA(){STRING = "str1"});

Output:

//This is a class level doc A
{
   //This is a string property
   "STRING": "str1"
}

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Newtonsoft.Json (>= 13.0.3)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.