Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion New Project - ThisAssembly.XmlDocs #292

Closed
rafaelsc opened this issue Feb 8, 2024 · 2 comments
Closed

Suggestion New Project - ThisAssembly.XmlDocs #292

rafaelsc opened this issue Feb 8, 2024 · 2 comments
Labels
question Further information is requested

Comments

@rafaelsc
Copy link

rafaelsc commented Feb 8, 2024

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 = "";
						}
					}
				}
			}
		}
	}
}
@rafaelsc rafaelsc added the bug Something isn't working label Feb 8, 2024
@kzu
Copy link
Member

kzu commented Feb 15, 2024

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... 🤔

@kzu kzu added question Further information is requested and removed bug Something isn't working labels Feb 15, 2024
@kzu
Copy link
Member

kzu commented Jul 21, 2024

Closing due to lack of interest.

@kzu kzu closed this as not planned Won't fix, can't repro, duplicate, stale Jul 21, 2024
@devlooped devlooped locked and limited conversation to collaborators Sep 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants