feat/code-quality (#350)

* Chore: file scoped namespace

* Feat: sign assembly
Fix: documentation on public methodes

* Fix: documentation and warnings

* Chore: split IPNetwork2 into multiple partial classes

* Chore: split IPNetwork2

* Chore: document partial classes

* Fix: order methodes

* Chore: documentd

* Chore: cleanup

Author: lduchosal

src/ConsoleApplication/ActionEnum.cs

@@ -4,6 +4,9 @@
 
 namespace System.Net;
 
+/// <summary>
+/// Switch and actions
+/// </summary>
 public enum ActionEnum
 {
     Usage,

src/ConsoleApplication/ArgParsed.cs

@@ -4,22 +4,41 @@
 
 namespace System.Net;
 
+/// <summary>
+/// The args from the command line.
+/// </summary>
 public class ArgParsed
 {
+    /// <summary>
+    /// Position.
+    /// </summary>
     public int Arg { get; set; }
 
     private event ArgParsedDelegate OnArgParsed;
 
+    /// <summary>
+    /// An arg has been parsed.
+    /// </summary>
     public delegate void ArgParsedDelegate(ProgramContext ac, string arg);
 
+    /// <summary>
+    /// Run the program with the args.
+    /// </summary>
+    /// <param name="ac">The context.</param>
+    /// <param name="arg">The arg.</param>
     public void Run(ProgramContext ac, string arg)
     {
-            this.OnArgParsed?.Invoke(ac, arg);
-        }
+        this.OnArgParsed?.Invoke(ac, arg);
+    }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ArgParsed"/> class.
+    /// </summary>
+    /// <param name="arg">The arg.</param>
+    /// <param name="onArgParsed">The event on parse.</param>
     public ArgParsed(int arg, ArgParsedDelegate onArgParsed)
     {
-            this.Arg = arg;
-            this.OnArgParsed += onArgParsed;
-        }
+        this.Arg = arg;
+        this.OnArgParsed += onArgParsed;
+    }
 }

src/ConsoleApplication/CidrParseTypeEnum.cs

@@ -4,6 +4,9 @@
 
 namespace System.Net;
 
+/// <summary>
+/// CidrParseEnum.
+/// </summary>
 public enum CidrParseEnum
 {
     Default,

src/ConsoleApplication/ConsoleApplication.csproj

@@ -1,9 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
 		<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
-		<TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">net9.0</TargetFrameworks>
 		<ImplicitUsings>disable</ImplicitUsings>
 		<SignAssembly>True</SignAssembly>
 		<AssemblyOriginatorKeyFile>..\System.Net.IPNetwork.snk</AssemblyOriginatorKeyFile>
@@ -13,6 +11,14 @@
 
 	</PropertyGroup>
 
+	<PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
+	  <NoWarn />
+	</PropertyGroup>
+
+	<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+	  <NoWarn />
+	</PropertyGroup>
+
 	<ItemGroup>
 	  <None Remove="stylecop.json" />
 	</ItemGroup>
@@ -29,9 +35,7 @@
 	  </PackageReference>
 	</ItemGroup>
 
-	
 	<ItemGroup>
-		<!-- ProjectReference Include="..\Gnu.Getopt\Gnu.Getopt.csproj" /-->
     <ProjectReference Include="..\System.Net.IPNetwork\System.Net.IPNetwork.csproj" />
   </ItemGroup>
 

src/ConsoleApplication/Program.cs

@@ -4,21 +4,19 @@
 
 namespace System.Net;
 
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
 using System.Numerics;
 using System.Reflection;
 using Gnu.Getopt;
 
-
-using System.Collections.Generic;
-
 /// <summary>
 /// Console app for IPNetwork.
 /// </summary>
 public class Program
 {
-    private static readonly Dictionary<int, ArgParsed> Args = new();
+    private static readonly Dictionary<int, ArgParsed> Args = new ();
 
     private static readonly ArgParsed[] ArgsList = new[]
     {
@@ -408,10 +406,7 @@ private static bool TryParseIPNetwork(string ip, CidrParseEnum cidrParseEnum, by
 
     private static bool PrintNoValue(ProgramContext ac)
     {
-        if (ac == null)
-        {
-            throw new ArgumentNullException(nameof(ac));
-        }
+        ArgumentNullException.ThrowIfNull(ac);
 
         return ac.IPNetwork == false
                && ac.Network == false
@@ -426,10 +421,7 @@ private static bool PrintNoValue(ProgramContext ac)
 
     private static void PrintAll(ProgramContext ac)
     {
-        if (ac == null)
-        {
-            throw new ArgumentNullException(nameof(ac));
-        }
+        ArgumentNullException.ThrowIfNull(ac);
 
         ac.IPNetwork = true;
         ac.Network = true;

src/ConsoleApplication/ProgramContext.cs

@@ -4,41 +4,98 @@
 
 namespace System.Net;
 
+/// <summary>
+/// The execution context.
+/// </summary>
 public class ProgramContext
 {
+    /// <summary>
+    /// Get or set the IPNetwork.
+    /// </summary>
     public bool IPNetwork { get; set; }
 
+    /// <summary>
+    /// Get or set the Network.
+    /// </summary>
     public bool Network { get; set; }
 
+    /// <summary>
+    /// Get or set the Netmask.
+    /// </summary>
     public bool Netmask { get; set; }
 
+    /// <summary>
+    /// Get or set the Cidr.
+    /// </summary>
     public bool Cidr { get; set; }
 
+    /// <summary>
+    /// Get or set the Broadcast.
+    /// </summary>
     public bool Broadcast { get; set; }
 
+    /// <summary>
+    /// Get or set the FirstUsable.
+    /// </summary>
     public bool FirstUsable { get; set; }
 
+    /// <summary>
+    /// Get or set the LastUsable.
+    /// </summary>
     public bool LastUsable { get; set; }
 
+    /// <summary>
+    /// Get or set the Usable.
+    /// </summary>
     public bool Usable { get; set; }
 
+    /// <summary>
+    /// Get or set the Total.
+    /// </summary>
     public bool Total { get; set; }
 
+    /// <summary>
+    /// Get or set the CidrParse.
+    /// </summary>
     public CidrParseEnum CidrParse { get; set; } = CidrParseEnum.Value;
 
+    /// <summary>
+    /// Get or set the CidrParsed.
+    /// </summary>
     public byte CidrParsed { get; set; } = 32;
 
+    /// <summary>
+    /// Get or set the ContainNetwork.
+    /// </summary>
     public IPNetwork2 ContainNetwork { get; set; }
 
+    /// <summary>
+    /// Get or set the OverlapNetwork.
+    /// </summary>
     public IPNetwork2 OverlapNetwork { get; set; }
 
+    /// <summary>
+    /// Get or set the SubtractNetwork.
+    /// </summary>
     public IPNetwork2 SubtractNetwork { get; set; }
 
+    /// <summary>
+    /// Get or set the Action.
+    /// </summary>
     public ActionEnum Action { get; set; } = ActionEnum.PrintNetworks;
 
+    /// <summary>
+    /// Get or set the SubnetCidr.
+    /// </summary>
     public byte SubnetCidr { get; set; }
 
+    /// <summary>
+    /// Get or set the NetworksString.
+    /// </summary>
     public string[] NetworksString { get; set; }
 
+    /// <summary>
+    /// Get or set the Networks.
+    /// </summary>
     public IPNetwork2[] Networks { get; set; }
 }