search

CommunityToolkit / WindowsCommunityToolkit

The Windows Community Toolkit is a collection of helpers, extensions, and custom controls. It simplifies and demonstrates common developer tasks building .NET apps with UWP and the Windows App SDK / WinUI 3 for Windows 10 and Windows 11. The toolkit is part of the .NET Foundation.
https://docs.microsoft.com/windows/communitytoolkit/
Other
5.89k stars 1.38k forks source link

Unify references to types in XML comments #3441

Open michael-hawker opened 4 years ago

michael-hawker commented 4 years ago

Based on a comment in #3434, we should do a better job of consistency in our XML comments.

We should do an audit and then add guidance in our contributor docs.

Side note - we should unify the way we display langwords in XML comments throughout the repository. Right now we have some displayed as plain text, some as inline markdown code (true), some as XML code blocks (<c>true</c>), some as XML langwords (langword="true").

_Originally posted by @Sergio0694 in https://github.com/windows-toolkit/WindowsCommunityToolkit/pull/3434#discussion_r472129802_

ghost commented 4 years ago

Hello michael-hawker, thank you for opening an issue with us!

I have automatically added a "needs triage" label to help get things started. Our team will analyze and investigate the issue, and escalate it to the relevant team if possible. Other community members may also look into the issue and provide feedback 🙌

michael-hawker commented 4 years ago

Another example: https://github.com/windows-toolkit/WindowsCommunityToolkit/pull/3434#discussion_r472131133

Side note, ideally all these type references should be proper XML refs, for consistency and also to allow devs to just CTRL + click into any of these to read more about them through the VS jump to definition feature.