Undocumented public API metric should count only documentation comments #2148
Conversation
ghost
assigned
| { | ||
| case SyntaxKind.SingleLineCommentTrivia: | ||
| case SyntaxKind.MultiLineCommentTrivia: | ||
| return trivia.ToString().TrimStart().StartsWith("///"); |
There was a problem hiding this comment.
Roslyn does not recognize the C# "documentation" comment trivia as such unless you specify "/p:DocumentationFile=foo.xml" as command line argument
There was a problem hiding this comment.
This comment should be put in the code.
| { | ||
| case SyntaxKind.DocumentationCommentExteriorTrivia: | ||
| case SyntaxKind.DocumentationCommentTrivia: | ||
| return true; |
There was a problem hiding this comment.
It looks like Roslyn always recognizes documentation comments for VB.NET
There was a problem hiding this comment.
I think this comment should be in the code (reworded).
| protected override IEnumerable<SyntaxNode> PublicApiNodes => | ||
| publicApis.Value; | ||
| protected override ImmutableArray<SyntaxNode> PublicApiNodes => | ||
| publicApiNodes.Value; |
There was a problem hiding this comment.
Renaming to be consistent with C#
| @@ -296,20 +296,18 @@ public void linesOfCodeByLine() { | |||
|
|
|||
| assertThat(value).contains("9=1"); | |||
| assertThat(value).contains("10=1"); | |||
|
|
|||
| assertThat(value).contains("11=1"); | |||
There was a problem hiding this comment.
The lines of code shifted because of the new comments I added
| @@ -25,7 +27,7 @@ class Class1 | |||
| public void Main() | |||
| { | |||
| MyClazz myClazz = new MyClazz(); | |||
| Console.WriteLine("Hello, world! " + myClazz.MyProperty); | |||
| Console.WriteLine(myClazz.MyProperty); | |||
There was a problem hiding this comment.
Forgot to revert this change I made while debugging...
| publicNodes.Add(member); | ||
| } | ||
|
|
||
| if (!isPublic && |
There was a problem hiding this comment.
You could do else if (!member.IsKind(SyntaxKind.NamespaceDeclaration)) to avoid repeating the !isPublic that is already tested previously.
| switch (trivia.Kind()) | ||
| { | ||
| case SyntaxKind.SingleLineCommentTrivia: | ||
| case SyntaxKind.MultiLineCommentTrivia: |
There was a problem hiding this comment.
I don't see why we check MultiLineCommentTrivia as we check /// right after.
| { | ||
| case SyntaxKind.SingleLineCommentTrivia: | ||
| case SyntaxKind.MultiLineCommentTrivia: | ||
| return trivia.ToString().TrimStart().StartsWith("///"); |
There was a problem hiding this comment.
This comment should be put in the code.
| { | ||
| case SyntaxKind.DocumentationCommentExteriorTrivia: | ||
| case SyntaxKind.DocumentationCommentTrivia: | ||
| return true; |
There was a problem hiding this comment.
I think this comment should be in the code (reworded).
Fix #2144