-
Notifications
You must be signed in to change notification settings - Fork 222
/
CommentsShouldNotBeEmpty.cs
87 lines (76 loc) · 3.39 KB
/
CommentsShouldNotBeEmpty.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*
* SonarAnalyzer for .NET
* Copyright (C) 2015-2023 SonarSource SA
* mailto: contact AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
using System.Text;
namespace SonarAnalyzer.Rules.CSharp;
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class CommentsShouldNotBeEmpty : CommentsShouldNotBeEmptyBase<SyntaxKind>
{
protected override ILanguageFacade<SyntaxKind> Language => CSharpFacade.Instance;
protected override string GetCommentText(SyntaxTrivia trivia) =>
trivia.Kind() switch
{
SyntaxKind.SingleLineCommentTrivia => GetSingleLineText(trivia),
SyntaxKind.MultiLineCommentTrivia => GetMultiLineText(trivia),
SyntaxKind.SingleLineDocumentationCommentTrivia => GetSingleLineDocumentationText(trivia),
SyntaxKind.MultiLineDocumentationCommentTrivia => GetMultiLineDocumentationText(trivia),
};
// //
private static string GetSingleLineText(SyntaxTrivia trivia) =>
trivia.ToString().Trim().Substring(2);
// ///
private static string GetSingleLineDocumentationText(SyntaxTrivia trivia)
{
var stringBuilder = new StringBuilder();
foreach (var line in trivia.ToFullString().Split(MetricsBase.LineTerminators, StringSplitOptions.None))
{
var trimmedLine = line.TrimStart(null);
trimmedLine = trimmedLine.StartsWith("///")
? trimmedLine.Substring(3).Trim()
: trimmedLine.TrimEnd(null);
stringBuilder.Append(trimmedLine);
}
return stringBuilder.ToString();
}
// /* */
private static string GetMultiLineText(SyntaxTrivia trivia) =>
ParseMultiLine(trivia.ToString(), 2); // Length of "/*"
// /** */
private static string GetMultiLineDocumentationText(SyntaxTrivia trivia) =>
ParseMultiLine(trivia.ToFullString(), 3); // Length of "/**"
private static string ParseMultiLine(string commentText, int initialTrimSize)
{
commentText = commentText.Trim().Substring(initialTrimSize);
if (commentText.EndsWith("*/", StringComparison.Ordinal)) // Might be unclosed, still reported
{
commentText = commentText.Substring(0, commentText.Length - 2);
}
var stringBuilder = new StringBuilder();
foreach (var line in commentText.Split(MetricsBase.LineTerminators, StringSplitOptions.None))
{
var trimmedLine = line.TrimStart(null);
if (trimmedLine.StartsWith("*", StringComparison.Ordinal))
{
trimmedLine = trimmedLine.TrimStart('*');
}
stringBuilder.Append(trimmedLine.Trim());
}
return stringBuilder.ToString();
}
}