Skip to content

Automatically fill out documentation based on config #128

Open
@Liamth99

Description

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions