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.

Sign up for GitHub

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

Jump to bottom

Add potential exceptions when generating doc comment #54894

Merged
merged 10 commits into from
Jul 28, 2021
Merged

Add potential exceptions when generating doc comment #54894

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dbd3cba
Add potential exceptions when generating doc comment
Youssef1313 Jul 17, 2021
e491eb4
handle constructors
Youssef1313 Jul 17, 2021
2101fc7
More work
Youssef1313 Jul 17, 2021
d8f3033
Remaining work
Youssef1313 Jul 18, 2021
469fb79
Fix test
Youssef1313 Jul 18, 2021
8525242
Address part of feedback
Youssef1313 Jul 21, 2021
69e89da
Merge remote-tracking branch 'upstream/main' into exceptions-doc-comm…
CyrusNajmabadi Jul 28, 2021
f24f8a9
Work
CyrusNajmabadi Jul 28, 2021
a395d1d
Only use syntax
CyrusNajmabadi Jul 28, 2021
c24f3c4
restore
CyrusNajmabadi Jul 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions src/EditorFeatures/CSharpTest/DocumentationComments/DocumentationCommentTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,72 @@ public void TypingCharacter_Method()
VerifyTypingCharacter(code, expected);
}

[WpfFact, Trait(Traits.Feature, Traits.Features.DocumentationComments)]
[WorkItem(54245, "https://github.com/dotnet/roslyn/issues/54245")]
public void TypingCharacter_Method_WithExceptions()
{
var code =
@"class C
{
//$$
int M<T>(int goo)
{
if (goo < 0) throw new /*leading trivia*/Exception/*trailing trivia*/();
return 0;
}
}";

var expected =
@"class C
{
/// <summary>
/// $$
/// </summary>
/// <typeparam name=""T""></typeparam>
/// <param name=""goo""></param>
/// <returns></returns>
/// <exception cref=""Exception""></exception>
int M<T>(int goo)
{
if (goo < 0) throw new /*leading trivia*/Exception/*trailing trivia*/();
return 0;
}
}";

VerifyTypingCharacter(code, expected);
}

[WpfFact, Trait(Traits.Feature, Traits.Features.DocumentationComments)]
[WorkItem(54245, "https://github.com/dotnet/roslyn/issues/54245")]
public void TypingCharacter_Constructor_WithExceptions()
{
var code =
@"class C
{
//$$
public C(int goo)
{
if (goo < 0) throw new /*leading trivia*/Exception/*trailing trivia*/();
}
}";

var expected =
@"class C
{
/// <summary>
/// $$
/// </summary>
/// <param name=""goo""></param>
/// <exception cref=""Exception""></exception>
public C(int goo)
{
if (goo < 0) throw new /*leading trivia*/Exception/*trailing trivia*/();
}
}";

VerifyTypingCharacter(code, expected);
}

[WpfFact, Trait(Traits.Feature, Traits.Features.DocumentationComments)]
public void TypingCharacter_Method_WithVerbatimParams()
{
Expand Down
36 changes: 32 additions & 4 deletions src/Features/CSharp/Portable/DocumentationComments/DocumentationCommentSnippetService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
using Microsoft.CodeAnalysis.DocumentationComments;
using Microsoft.CodeAnalysis.Host.Mef;
using Microsoft.CodeAnalysis.Shared.Extensions;
using Roslyn.Utilities;

namespace Microsoft.CodeAnalysis.CSharp.DocumentationComments
{
Expand Down Expand Up @@ -111,22 +112,49 @@ protected override List<string> GetDocumentationCommentStubLines(MemberDeclarati
}
}

if (member.IsKind(SyntaxKind.MethodDeclaration) ||
member.IsKind(SyntaxKind.IndexerDeclaration) ||
member.IsKind(SyntaxKind.DelegateDeclaration) ||
member.IsKind(SyntaxKind.OperatorDeclaration))
if (member.IsKind(
SyntaxKind.MethodDeclaration,
SyntaxKind.IndexerDeclaration,
SyntaxKind.DelegateDeclaration,
SyntaxKind.OperatorDeclaration,
SyntaxKind.ConstructorDeclaration,
SyntaxKind.DestructorDeclaration))
{
var returnType = member.GetMemberType();
if (returnType != null &&
!(returnType.IsKind(SyntaxKind.PredefinedType, out PredefinedTypeSyntax? predefinedType) && predefinedType.Keyword.IsKindOrHasMatchingText(SyntaxKind.VoidKeyword)))
{
list.Add("/// <returns></returns>");
}

foreach (var exceptionType in GetExceptions(member))
{
list.Add(@$"/// <exception cref=""{exceptionType}""></exception>");
}
}

return list;
}

private static IEnumerable<string> GetExceptions(SyntaxNode member)
{
var statements = member.DescendantNodes().Where(n => n.IsKind(SyntaxKind.ThrowExpression, SyntaxKind.ThrowStatement));
foreach (var statement in statements)
{
var expression = statement switch
{
ThrowExpressionSyntax throwExpression => throwExpression.Expression,
ThrowStatementSyntax throwStatement => throwStatement.Expression,
_ => throw ExceptionUtilities.Unreachable
};

if (expression is ObjectCreationExpressionSyntax { Type: TypeSyntax type })
{
yield return type.ToString();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likely won't work with generics. But that's likely so niche as to not be relevant.

Is also like it if we filtered it exceptions in an inner scope that are caught before escaping.

}
}
}

protected override SyntaxToken GetTokenToRight(
SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
{
Expand Down