Suggestion New Project - ThisAssembly.XmlDocs

[rafaelsc]

Suggestion for creating a new Project ThisAssembly.XmlDocs to auto generate a code to access the XML Docs from Classes and Members via code.

This could,

/// <summary>
/// Url Helper Utility Class
/// </summary>
internal static class UrlHelper
{
	/// <summary>
	/// Check if a string is a valid URL
	/// </summary>
	/// <param name="url">The string representation of the Uri.</param>
	/// <returns>true</returns>
	public static bool IsValidUrl(string url) => true;

	/// <summary>
	/// 
	/// </summary>
	/// <param name="url"></param>
	/// <param name="onlyIntranet"></param>
	/// <returns></returns>
	public static bool IsValidUrl(string url, bool onlyIntranet) => true;
}

Could generate a code like this.

partial class ThisAssembly
{
	public static partial class XmlDocs
	{
		public static partial class UrlHelper
		{
			public const string Summary = "Url Helper Utility Class";

			public static partial class IsValidUrl
			{
				public static partial class Overloads
				{
					public static partial class String
					{
						public const string Summary = "Check if a string is a valid URL";
						public const string Returns = "true";
						public static partial class Params
						{
							public const string Url = "The string representation of the Uri.";
						}
					}

					public static partial class StringBool
					{
						public const string Summary = "";
						public const string Returns = "";
						public static partial class Params
						{
							public const string Url = "";
							public const string OnlyIntranet = "";
						}
					}
				}
			}
		}
	}
}

[kzu]

Seems like this could be bloating the resulting assembly with a whole bunch of strings that would otherwise be easily available by loading the XML alongside the assembly with an API like NuDoq... 🤔