C# Xml doc

[tonerdo]

This PR adds content for C# Code documentation.

Changes include

• Brief description of XML documentation tags and how to enable it in project.json
• Reference to XML documentation tags
• Example usage of each tag

Fixes #67

/cc @BillWagner

[dnfclas]

Hi @tsolarin, I'm your friendly neighborhood .NET Foundation Pull Request Bot (You can call me DNFBOT). Thanks for your contribution!
You've already signed the contribution license agreement. Thanks!

The agreement was validated by .NET Foundation and real humans are currently evaluating your PR.

TTYL, DNFBOT;

[svick]

Wrench should also be removed from docs/toc.md.

[BillWagner]

@tsolarin This is a good start. Overall, you know the topic well, and the information is all here.

I'd like to see this become more of a tutorial or guide, and less of a reference document. The C# spec contains information on the tags and their syntax. This article can really help readers by giving them examples and recommendations on using the /// comments in their own libraries.

There are questions that the spec doesn't answer that should be in this topic:

1. What happens when I have partial classes and comments in both parts?
2. What tags would be best for a class, a member, a delegate, and so on?
3. What tools can build a website for my library from the XML?

Again, thank you for contributing. We really appreciate seeing people get involved in the project, and helping make a better experience for the .NET Community.

[tonerdo]

@BillWagner @svick thanks for the reviews, I'll get to addressing your comments and will mention you guys again when it's ready for re-review

[BillWagner]

@tsolarin I saw that you pushed an update, but I didn't know if you were ready for a review yet. Should I give this a look over, or should I wait for further updates?

[tonerdo]

@BillWagner I have one more update coming and then it should be ready for another review

[tonerdo]

Ready for another look over

/cc @BillWagner @svick

[tonerdo]

Notifying again

/cc @BillWagner @svick

[BillWagner]

split into 2 lines.

[BillWagner]

@tsolarin This looks really good. I left a few final (minor) comments. Some are also suggestions. You should decide if you like that style or not.

Can you fix the merge conflicts? I think those are in the TOC changes. Let me know if you've used git rebase before. If not, I'll help walk you through it.

[tonerdo]

@BillWagner thanks. I can do a rebase alright. Quick question though, on splitting of the contents of the <exception> tag into multiple lines should I use <para> tags or normal line breaks?

[BillWagner]

@tsolarin A normal line break. Code lines don't auto wrap, so those force the user to scroll to the right.

[tonerdo]

Merge conflicts all fixed up, and comments addressed. Ready for another go
/cc @BillWagner

[BillWagner]

I gave it a final review, and it's ready to merge, as soon as the CI build finishes.

Thank you for all your work on this. It's a great addition, and I hope you enjoyed the experience.

🎆

[cartermp]

👍, thanks @tsolarin! Great article.

[tonerdo]

@BillWagner @cartermp thanks a lot, I really enjoyed the experience and learnt a whole lot in the process. Looking forward to contributing some more.