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: use XML documentation comments #3

Open
knipp opened this issue Jul 25, 2018 · 1 comment
Open

Suggestion: use XML documentation comments #3

knipp opened this issue Jul 25, 2018 · 1 comment

Comments

@knipp
Copy link

knipp commented Jul 25, 2018

@HarmJ0y I think the code could benefit from using XML style comments instead of regular comments especially at the beginning of functions. This would give more meaningful IntelliSense hints when using the functions, and would allow for automatic documentation generation through Sandcastle.

https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments

I'd be willing to rework the existing comments into XML style comments and create a pull request for it, if you are interested. It would look more or less like this:

Before:
// checks if the current user has the specified AccessRight to the specified file or folder
// from https://stackoverflow.com/questions/1410127/c-sharp-test-if-user-has-write-access-to-a-folder/21996345#21996345

After:
/// <summary>
/// checks if the current user has the specified AccessRight to the specified file or folder
/// </summary>
/// <see cref="https://stackoverflow.com/questions/1410127/c-sharp-test-if-user-has-write-access-to-a-folder/21996345#21996345"/>
/// <param name="Path">Path to check access for</param>
/// <param name="AccessRight">The specific permission to check</param>
/// <returns>true if access is allowed, false otherwise</returns>

@HarmJ0y
Copy link
Member

HarmJ0y commented Aug 20, 2018

Good idea, my C# n00bness is showing :) I'll definitely check this out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants