Skip to content

Reorder xml documentation param tags, to match the order of method params #756

Open
@hyankov

Description

@hyankov

Environment

  • Visual Studio version: 2019 Professional
  • CodeMaid version: 11.1.209
  • Code language: C#

Description

This is a feature request - CodeMaid should/could reorder the param XML comments, to match the order of the actual method parameters.

Steps to recreate

Given:

public class MyClass
{
		/// <summary>
		/// ...
		/// </summary>
		/// <param name="param2">Param 2.</param>
		/// <param name="param1">Param 1.</param>
		/// <returns>...</returns>
		public int SomeMethod(string param1, string param2) { }
}

When you clean-up this code, it should change to:

public class MyClass
{
		/// <summary>
		/// ...
		/// </summary>
		/// <param name="param1">Param 1.</param>
		/// <param name="param2">Param 2.</param>
		/// <returns>...</returns>
		public int SomeMethod(string param1, string param2) { }
}

Current behavior

Right now CodeMaid does not change the order of param, to match the method order of params.

Expected behavior

On clean-up, CodeMaid changes the order of param tags, to match the order of method params.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions