Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

inheritdoc + cref #3652

Closed
ZacharyPatten opened this issue Mar 11, 2020 · 3 comments · Fixed by #3928
Closed

inheritdoc + cref #3652

ZacharyPatten opened this issue Mar 11, 2020 · 3 comments · Fixed by #3928

Comments

@ZacharyPatten
Copy link

ZacharyPatten commented Mar 11, 2020

The inheritdoc feature in C# let's you use cref to specify the member you want to inherit documentation from.

It doesn't look like the C# extension for Visual Studio Code supports this functionality yet (but it is supported in Visual Studio). For example, when you hover over members of code that use inheritdoc+cref the documentation is blank (not populating).

It was also recently added to ms docs: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/inheritdoc

If this feature could be added to the C# Visual Studio Code extension it would be really nice. :)

Example:

class Program
{
	/// <summary>Hello World</summary>
	public static void A() { }

	/// <inheritdoc cref="A"/>
	public static void B() { }

	public static void Main()
	{
		A(); // <- Documentation Populated In UI
		B(); // <- Documentation Not Populated In UI
	}
}
@cartermp
Copy link

Might be because OmniSharp doesn't have the most recent Roslyn; if not, then some feature work is needed. @JoeRobich to investigate the update

@dietermijle
Copy link

+1

@333fred
Copy link
Member

333fred commented Jul 24, 2020

This will be fixed by OmniSharp/omnisharp-roslyn#1860.

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

Successfully merging a pull request may close this issue.

5 participants