SpecFlow.Rider icon indicating copy to clipboard operation
SpecFlow.Rider copied to clipboard

Question: How to get the step by step documentation?

Open egorsh0 opened this issue 2 years ago • 1 comments

Good afternoon There is a set of steps that can be either in a separate class or in a nuget package, described in a standard way:

    [Binding]
    public class Steps
    {
        [StepDefinition(@"write in console ""(.+)""")]
        public void WriteInConsole(string varName)
        {
            Console.WriteLine(varName)
        }
    }

And when there is an attempt to find this step in the IDE (VS/Rider), you can only see the information in the attribute. As example Given write in console "test" The question is, is it possible to somehow use the documentation of the function described in Summary and so on and display it in the IDE? Or is there another way I don't know about?

Example:

        [Binding]
        public class Steps
        {
            /// <summary>
            /// Step to output values to the console.
            /// </summary>
            /// <param name="varName">Variable for output.</param>
            [StepDefinition(@"write in console ""(.+)""")]
            public void WriteInConsole(string varName)
            {
                Console.WriteLine(varName)
            }
        }

egorsh0 avatar Mar 02 '23 17:03 egorsh0

Seems the documentation is displayed when it come from the code, when it come from a nuget I'm not sure how this can work.

image image

Are you speaking about this or something else ?

Socolin avatar Nov 26 '23 06:11 Socolin