MiJenner.DocUtils 0.9.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package MiJenner.DocUtils --version 0.9.1
                    


                    

                
NuGet\Install-Package MiJenner.DocUtils -Version 0.9.1
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="MiJenner.DocUtils" Version="0.9.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="MiJenner.DocUtils" Version="0.9.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="MiJenner.DocUtils" />
                    


                            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 MiJenner.DocUtils --version 0.9.1
                    


                    

                
#r "nuget: MiJenner.DocUtils, 0.9.1"
#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 MiJenner.DocUtils@0.9.1
#: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=MiJenner.DocUtils&version=0.9.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=MiJenner.DocUtils&version=0.9.1
                    


                            Install as a Cake Tool

MiJenner.DocUtils

DocUtils offer cross-platform utilities for easy overview documentation of your .cs files.

The method WriteDoc(string codePath) extracts an overview of classes in the file, their constructors with parameters. Further, the properties and fields of each class are listed together with access modifiers. And finally all methods, their access modifiers and their parameters are listed. The output is written to console. Often this is too much information, but it is easier to delete the extran information than to write the whole overview manually.

Method Signatures

Below is listed the signatures of the methods:

public static void WriteDoc(string codePath)

Examples

Identify the full path of the source files you want to analyze. This can be done from Visual Studio by right clicking and "Copy Full Path".

Create a console application project.

Add a using instruction at the top:

using MiJenner.DocUtils;

Below are examples on how the library can be used:

string codePath = @"TestSourceFile.cs"; 
DocUtils.WriteDoc(codePath);

NuGet package

There is a NuGet package available for easy usage.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.

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
0.9.1 219 4/24/2024
0.9.0 180 4/24/2024