You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
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:
Expected
Documentation on alternative method of documentation.
Example of working code (recognized in Intellisense).
Actual
Documentation not available, and method not supported by Visual Studio's Intellisense.
The text was updated successfully, but these errors were encountered: