SpecFlowOSS / SpecFlow

#1 .NET BDD Framework. SpecFlow automates your testing & works with your existing code. Find Bugs before they happen. Behavior Driven Development helps developers, testers, and business representatives to get a better understanding of their collaboration
https://www.specflow.org/
Other
2.22k stars 752 forks source link

How to get the step by step documentation? #2698

Closed egorsh0 closed 1 year ago

egorsh0 commented 1 year ago

Link to Feature Request

No response

Implementation Idea

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)
            }
        }
github-actions[bot] commented 1 year ago

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.