Debugland 2.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Debugland --version 2.0.0
                    
NuGet\Install-Package Debugland -Version 2.0.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="Debugland" Version="2.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Debugland" Version="2.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Debugland" />
                    
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 Debugland --version 2.0.0
                    
#r "nuget: Debugland, 2.0.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 Debugland@2.0.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=Debugland&version=2.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Debugland&version=2.0.0
                    
Install as a Cake Tool

GITHUBBANNER ko-fi

In the dynamic world of software development, Debugland stands as a beacon, revolutionizing the debugging experience during runtime. Designed to bring clarity and readability to the often intricate process of troubleshooting, Debugland introduces a suite of features that seamlessly integrate into your development workflow.

To learn how to set it up please follow the next seciton

Setup

  • download Debugland via nuget Manager
  • Write the following at the beginning of your code:
  using Debugger = Debugland.Debugger;

And you're good to go!

The next section will show you how to use the methods that Debugland has.

Documentaiton

MethodInitiated and MethodTerminated

The Initiation and termination method is crucial for starting every debug process when using Debugland. It plays a vital role in the overall layout in the debug window.

Example:

//start by making a method
public void TestMethod()
{
  //initiate the debugger with the name of this method
  Debugger.MethodInitiated("TestMethod");

  Method Logic ...

  //Terminate the debugger for this method
  Debugger.MethodTerminated("TestMethod");
}

debug output display

  [TestMethod]
    → initiated
  [/TestMethod]

TimeInitiated and Timeterminated

The purpose of this method is to track the time of a method

//start by making a method with the debugger initiated and terminated
public void TestMethod()
{
  Debugger.MethodInitiated("TestMethod");
  // Initiate the time tracking,
  Debugger.TimeInitiated("TestMethod");

  Method Logic ...

  //Terminate the debugger for this method
  Debugger.TimeTerminated
  Debugger.MethodTerminated("TestMethod");
}

debug output display

  [TestMethod]
    → initiated
    ← Elapsed time for TestMethod: 15 milliseconds
  [/TestMethod]

Message and MessageImportant

This simple method is for writing a message in the debug window. Along with MessageImportant you can highten awareness along certain steps in your debugging

//start by making a method with the debugger initiated and terminated
public void TestMethod()
{
  Debugger.MethodInitiated("TestMethod");
  // Write the message method anywhere in your methods.,
  Debugger.Message("A message");
  Debugger.MessageImportant("An Important Message");
  Debugger.MethodTerminated("TestMethod");
}

debug output display

  [TestMethod]
    → initiated
    ! A message
    ‼ An Important Message
  [/TestMethod]

Tracking SQL

Now this part contains multiple methods that works well together. But you can use them as you see fit. If you want to track sql stuff the following methods will enable this:

  • SQLCommandInitiated
  • SQLCommandTerminated
  • ReaderInitiated
  • ReaderTerminated
  • SQLConnectionInitiated
  • SQLConnectionTerminated

When they're all combined it will look like this:

//start by making a method with the debugger initiated and terminated
public void TestMethod()
{
  Debugger.MethodInitiated("TestMethod");
  // Write the message method anywhere in your methods.,
  Debugger.SQLConnectionInitiated();
  Debugger.SQLCommandInitiated("A specific command");
  Debugger.ReaderInitiated();
  Debugger.ReaderTerminating();
  Debugger.SQLCommandTerminating();
  Debugger.SQLConnectionTerminating();
}

debug output display

  [TestMethod]
    →initialized
    ┌SQL Connection Initiated
    ┌SQL Command: A specific command
    |Reader initialized
    |Reader executed
    |Command Terminated
    └SQL Connection Terminated
  [/TestMethod]
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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.1.1 172 3/3/2024
2.0.0 145 2/7/2024
1.1.1 145 1/30/2024
1.1.0 169 1/9/2024
1.0.2 146 1/4/2024
1.0.1 152 1/3/2024
1.0.0 142 1/2/2024

A release of Debugland