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

Automatically fill out documentation based on config #128

Open
Liamth99 opened this issue Apr 21, 2022 · 0 comments
Open

Automatically fill out documentation based on config #128

Liamth99 opened this issue Apr 21, 2022 · 0 comments

Comments

@Liamth99
Copy link

Liamth99 commented Apr 21, 2022

For example:

/// <summary>
/// Gets the number in the middle of 2 numbers
/// </summary>
/// <param name="a">First number</param>
/// <param name="b">Second number</param>
/// <returns>The middle number as an Int</returns>
int GetMiddle(int a, int b)
{
   return answer;
}

/// <summary>
/// 
/// </summary>
/// <param name="a"></param>
/// <param name="b"></param>
/// <returns></returns>
double GetMiddle(double a, double b)
{
   return answer;
}

Could we have some sort of option to add something like this (this is just pseudo json of course):

"AutomaticDocumentation":
   "a", "First number",
   "b", "Second number",
   "GetMiddle":
      "summary": "Gets the number in the middle of 2 numbers",
      "returns": "The middle number as an Int"

So that my second method is already filled out automatically. I'm writing a math library and there are lots of variants of the same equations taking in all sorts of parameters over and over, it would be much easier with something like this.

I also found this https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags#reuse-documentation-text

@Liamth99 Liamth99 changed the title Automatically fill out documentation based on a dictionary Automatically fill out documentation based on config Apr 21, 2022
@kasecato kasecato self-assigned this May 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants