Skip to content

Insert documentation comments only on supported declarations #59084

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

Merged
merged 2 commits into from
Jan 27, 2022
Merged

Insert documentation comments only on supported declarations #59084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
400c04e
Insert documentation comments only on supported declarations
Youssef1313 Jan 26, 2022
6f1beb9
Update DocumentationCommentTests.cs
Youssef1313 Jan 26, 2022
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
42 changes: 42 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 @@ -706,6 +706,48 @@ public void TypingCharacter_NotInsideCtor()
VerifyTypingCharacter(code, expected);
}

[WorkItem(59081, "https://github.com/dotnet/roslyn/issues/59081")]
[WpfFact, Trait(Traits.Feature, Traits.Features.DocumentationComments)]
public void TypingCharacter_NotInTopLevel()
{
var code = @"
using System;

//$$
Console.WriteLine();
";

var expected = @"
using System;

///$$
Console.WriteLine();
";

VerifyTypingCharacter(code, expected);
}

[WorkItem(59081, "https://github.com/dotnet/roslyn/issues/59081")]
[WpfFact, Trait(Traits.Feature, Traits.Features.DocumentationComments)]
public void TypingCharacter_NotInNamespace()
{
var code = @"
using System;

//$$
namespace NS { }
";

var expected = @"
using System;

///$$
namespace NS { }
";

VerifyTypingCharacter(code, expected);
}

[WpfFact, Trait(Traits.Feature, Traits.Features.DocumentationComments)]
public void PressingEnter_InsertComment_Class1()
{
Expand Down
3 changes: 0 additions & 3 deletions ...eatures/CSharp/Portable/DocumentationComments/CSharpDocumentationCommentSnippetService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,6 @@ protected override int GetPrecedingDocumentationCommentCount(MemberDeclarationSy
return count;
}

protected override bool IsMemberDeclaration(MemberDeclarationSyntax member)
=> true;

protected override List<string> GetDocumentationCommentStubLines(MemberDeclarationSyntax member)
{
var list = new List<string>
Expand Down
3 changes: 1 addition & 2 deletions ...eatures/Core/Portable/DocumentationComments/AbstractDocumentationCommentSnippetService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ internal abstract class AbstractDocumentationCommentSnippetService<TDocumentatio
protected abstract bool SupportsDocumentationComments(TMemberNode member);
protected abstract bool HasDocumentationComment(TMemberNode member);
protected abstract int GetPrecedingDocumentationCommentCount(TMemberNode member);
protected abstract bool IsMemberDeclaration(TMemberNode member);
protected abstract List<string> GetDocumentationCommentStubLines(TMemberNode member);

protected abstract SyntaxToken GetTokenToRight(SyntaxTree syntaxTree, int position, CancellationToken cancellationToken);
Expand Down Expand Up @@ -151,7 +150,7 @@ public bool IsValidTargetMember(SyntaxTree syntaxTree, SourceText text, int posi
{
var targetMember = documentationComment.ParentTrivia.Token.GetAncestor<TMemberNode>();

if (targetMember == null || !IsMemberDeclaration(targetMember))
if (targetMember == null || !SupportsDocumentationComments(targetMember))
{
return null;
}
Expand Down
4 changes: 0 additions & 4 deletions ...sualBasic/Portable/DocumentationComments/VisualBasicDocumentationCommentSnippetService.vb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,6 @@ Namespace Microsoft.CodeAnalysis.VisualBasic.DocumentationComments
Return count
End Function

Protected Overrides Function IsMemberDeclaration(member As DeclarationStatementSyntax) As Boolean
Return member.IsMemberDeclaration()
End Function

Protected Overrides Function GetDocumentationCommentStubLines(member As DeclarationStatementSyntax) As List(Of String)
Dim list = New List(Of String) From {
"''' <summary>",
Expand Down