c# .cs file with http relative link in comment in Visual Studio

Question

Let Say I have following C# project structure in Visual Studio

Spec
- UserStory1.html
- UserStory2.html
Tests
- Test1.cs
- Test2.cs

Now I want to connect my unit tests with Specification written in html in the following way

//http://../path.to.UserStory1.html#or_even_some_anchor
[TestFixture]
public class Test1
{
    [Test]
    public void SomeTest()
    {

    }        
}

That way when I CTRL+Clik on the link in the comment I can jump to the specification and see what should be really tested. Problem is that I don't know how to do a relative path to html file included in the project.

How can I do that?
If not in standard VS, is there some plugin available that will enable this?

Did my answer below solve your problem?

Ryan Gates
– Ryan Gates

2015-06-19 18:13:24 +00:00
Commented Jun 19, 2015 at 18:13 — Ryan Gates
– Ryan Gates, Commented Jun 19, 2015 at 18:13

blackgreen · Accepted Answer · 2024-05-23 07:51:01Z

3

I think that in your case the <see/> documentation tag would make the most sense, but others are available.

This would change your example code to be the following:

/// <summary>
/// This test does something
/// </summary>
/// <see cref="http://../path.to.UserStory1.html#or_even_some_anchor"/>
[TestFixture]
public class Test1
{
    [Test]
    public void SomeTest() { }        
}

I tested with http://www.google.com and it opened it in a new tab within VS. All of this is built into VS without any additional add-ons.

edited May 23, 2024 at 7:51

blackgreen♦

46.9k29 gold badges171 silver badges162 bronze badges

answered Jun 20, 2013 at 17:24

Ryan Gates

4,5797 gold badges53 silver badges93 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

c# .cs file with http relative link in comment in Visual Studio

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related