-
Notifications
You must be signed in to change notification settings - Fork 308
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Please consider adding XML documentation for Fluent razor components #134
Comments
This sounds like a a great improvement. We'd love to have this as a community contribution 馃槃 |
@EisenbergEffect Yes. |
@ShreyasJejurkar |
Thanks, @vnbaaij. I will start working on this one-by-one component this upcoming weekend. |
@ShreyasJejurkar, @EisenbergEffect Maybe we should use this opportunity to also move the c# code out of the |
@vnbaaij Hmm. Yeh. That would be a good idea to have a separate file for code-behind |
@vnbaaij In order to minimize conflicts, how do we want to order the PRs? Should we get the namespace/using PR in first, then the update to .razor.cs and then the update to the doc comments? I can probably get the namespace PR merged today. Thoughts? |
@EisenbergEffect Yup. @vnbaaij 's namespace PR - > moving it to |
@EisenbergEffect If you canget #126 in first, I'll post another PR to move the code to separate files, update usings, etc in a bit (working on that rn) |
#126 is now merged 馃槃 (I really like the new using and namespace features.) |
@EisenbergEffect yup, that feature is quite good one! |
@EisenbergEffect #138 is ready for merging the changes mentioned above |
Closed with #188 |
馃檵 Documentation Request
Please consider adding XML documentation for C# blazor component API.
Consider the following scenario, how come newcomers know what needs to be used for rendering anchor tags, as they see two components here.
If we compare this with inbuilt blazor components, at least we get some component information while typing itself.
馃拋 Possible Solution
We should consider adding XML documentation for these components and as well as their individual properties, as these comments can be inferred by Visual Studio and Visual Studio Code and provide a great experience for developers!
I am ready to help with this task to get it complete馃槄. But filling issue first so that we can track progress and I can know other people's thoughts on it if I miss anything here!
The text was updated successfully, but these errors were encountered: