Improve HttpUtility.ParseQueryString formatting and code snipped for C#

[JoanGil]

Hi all!

I checked the HttpUtility.ParseQueryString method documentation and I realized that some of the formatting and variable naming could be greatly improved.

I could create a pull request and change these things if that's okay.

[ghost]

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

[Anttrap63]

.____

[ghost]

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Hi all!

I checked the HttpUtility.ParseQueryString method documentation and I realized that some of the formatting and variable naming could be greatly improved.

I could create a pull request and change these things if that's okay.

Author:	JoanGil
Assignees:	-
Labels:	untriaged, Pri3, area-System.Net.Http, needs-area-label
Milestone:	-

[MichaelDeutschCoding]

I would also note that this sample does not provide an easy way to run it and actually see the results, in particular the fact that:

Multiple occurrences of the same query string variable are consolidated in one entry of the returned NameValueCollection.

Would it be simpler to just remove all the Asp.Net specific renderings, and just Console.WriteLine() the results -- making it easier for readers to just copy and run. This would also allow including something like "output would look something like this: " within the snippet itself. That seems to be the approach I've seen in many other snippets.

[JoanGil]

I would also note that this sample does not provide an easy way to run it and actually see the results, in particular the fact that:

Multiple occurrences of the same query string variable are consolidated in one entry of the returned NameValueCollection.

Would it be simpler to just remove all the Asp.Net specific renderings, and just Console.WriteLine() the results -- making it easier for readers to just copy and run. This would also allow including something like "output would look something like this: " within the snippet itself. That seems to be the approach I've seen in many other snippets.

I completely agree with you. I could redo the code with better and simpler examples. What do you think? Also, @MichaelDeutschCoding do you know if I can already make the pull request or is it better to wait until someone from Microsoft "allows" it? And thanks for the response and the good suggestions!

[MichaelDeutschCoding]

From what I've seen, I think it's fine to open a PR, and then get input from someone on the team on the changes you make. Generally, they're more than happy for community contributions.

Here's one example of snippets that include the sample output. You can include something like that in this snippet as well.

If you do change the language to C# (as opposed to the current aspx-csharp), make sure to update that reference to the snippet as well as changing the extension from .aspx to .cs.

(If you're up to it, you may want to try updating the Visual Basic example as well 👍)

[JoanGil]

Okay, thanks for the detailed reply with all the information. I will give it a try!

[JoanGil]

One more question, maybe you know @MichaelDeutschCoding do you know, once all the changes are made, how to test the solution and see if the result is correct? I can't find the information anywhere in this repo... Thanks!

[MichaelDeutschCoding]

Personally, I use a program called LinqPad to run small snippets like this and confirm they work as I expect. Also helpful if you'd want to copy/paste the output to display it in the snippet.

You can also find online platforms that can run .NET code. The official Microsoft one is Try .NET (see more about it here). And .NET Fiddle is an older site that many people use which provides similar functionality.

You can even embed a Try .NET window into this documentation page to allow users to run your sample directly in their browser without having to even open another tab! Just add interactive="try-dotnet" when you reference the snippet from the documentation Xml file. (See an example of that usage here, and how that page appears in your browser.)

[JoanGil]

Thanks for all the information, that's very helpful. But my question was more about the dotnet-api-docs. I don't know how to test that my new files and all the documentation fit all together.