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

Documentation Block without XML (Missing from Spec) #1285

Open
spiritedsnowcat opened this issue Jan 29, 2018 · 3 comments
Open

Documentation Block without XML (Missing from Spec) #1285

spiritedsnowcat opened this issue Jan 29, 2018 · 3 comments
Labels

Comments

@spiritedsnowcat
Copy link

spiritedsnowcat commented Jan 29, 2018

Summary
Alternative method of documentation without XML wasn't specified in the new C# spec, but exists in old spec and the current F# spec (which is still online and can be linked to). This documentation style works in Visual Studio Code's Intellisense, but not Visual Studio's Intellisense.

Spec:

The following example shows the alternative method, without XML tags. In this example, the entire text in the comment is considered a summary. Note that if you do not specify a summary tag explicitly, you should not specify other tags, such as param or returns tags.

Expected
Documentation on alternative method of documentation.
Example of working code (recognized in Intellisense).

/// Adds two numbers using thread safety
public static int Add(int a, int b) {
	return Interlocked.Add(a, b);
}

Actual
Documentation not available, and method not supported by Visual Studio's Intellisense.

@svick
Copy link
Contributor

svick commented Jan 29, 2018

What old spec are you talking about? Can you link to it?

Just because F# does it this way, doesn't mean it will work in C# too. And since it's not actually working in VS, I think this not just about correcting the spec, it's about adding a new feature.

@TheUnlocked
Copy link

While this may not actually be a spec correction, I do think that it would be a valuable thing to add (or re-add?) in general.

@BillWagner
Copy link
Member

Not moving to dotnet/csharpstandard, as this isn't part of the current standard, but a request for an update.

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

No branches or pull requests

5 participants