[英]Unexpected line breaks with Roslyn C# CodeFixProvider and Trivia
[英]Consistent line endings in a Roslyn CodeFixProvider
我目前正在使用Visual Studio 2015中提供的Roslyn SDK開發CodeFixProvider
。提供程序的目標是為throw語句添加缺少的<exception>
文檔。
我正在建立這樣的語法:
var newNodes = new XmlNodeSyntax[]
{
SyntaxFactory.XmlText(
SyntaxFactory.TokenList(
SyntaxFactory.XmlTextLiteral(
SyntaxFactory.TriviaList(SyntaxFactory.DocumentationCommentExterior("///")),
string.Empty,
string.Empty,
SyntaxFactory.TriviaList()
),
SyntaxFactory.XmlTextNewLine(SyntaxFactory.TriviaList(), "\n", "\n", SyntaxFactory.TriviaList()),
SyntaxFactory.XmlTextLiteral(
SyntaxFactory.TriviaList(SyntaxFactory.DocumentationCommentExterior("///")),
" ",
" ",
SyntaxFactory.TriviaList()
)
)
),
SyntaxFactory.XmlElement(
SyntaxFactory.XmlElementStartTag(SyntaxFactory.XmlName("exception"))
.WithAttributes(SyntaxFactory.SingletonList<XmlAttributeSyntax>(
SyntaxFactory.XmlCrefAttribute(
SyntaxFactory.XmlName("cref"),
SyntaxFactory.Token(SyntaxKind.DoubleQuoteToken),
SyntaxFactory.NameMemberCref(
SyntaxFactory.IdentifierName(thrownTypeSymbol.ToMinimalDisplayString(semanticModel, throwSyntax.GetLocation().SourceSpan.Start))
),
SyntaxFactory.Token(SyntaxKind.DoubleQuoteToken)
).WithLeadingTrivia(
SyntaxFactory.TriviaList(
SyntaxFactory.Whitespace(" ")
)
)
)),
SyntaxFactory.XmlElementEndTag(SyntaxFactory.XmlName("exception"))
).WithContent(
SyntaxFactory.List<XmlNodeSyntax>(new[] {
SyntaxFactory.XmlText()
.WithTextTokens(
SyntaxFactory.TokenList(
SyntaxFactory.XmlTextNewLine(SyntaxFactory.TriviaList(), "\n", "\n", SyntaxFactory.TriviaList()),
SyntaxFactory.XmlTextLiteral(
SyntaxFactory.TriviaList(SyntaxFactory.DocumentationCommentExterior("///")),
" ",
" ",
SyntaxFactory.TriviaList()
),
SyntaxFactory.XmlTextNewLine(SyntaxFactory.TriviaList(), "\n", "\n", SyntaxFactory.TriviaList()),
SyntaxFactory.XmlTextLiteral(
SyntaxFactory.TriviaList(SyntaxFactory.DocumentationCommentExterior("///")),
" ",
" ",
SyntaxFactory.TriviaList()
)
)
)
})
),
SyntaxFactory.XmlText(
SyntaxFactory.TokenList(
SyntaxFactory.XmlTextNewLine(
SyntaxFactory.TriviaList(),
Environment.NewLine,
Environment.NewLine,
SyntaxFactory.TriviaList()
)
)
)
};
然后將節點附加到現有的DocumentationCommentTriviaSyntax
節點。
newTrivia = xmlTrivia.AddContent(newNodes);
問題
這確實會添加缺少的<exception>文檔注釋,但可悲的是使用了錯誤的行尾。 我可以將硬編碼的\\n
更改為Environment.NewLine
但這仍可能與文件的行尾不匹配。
有沒有一種方法可以使用要應用修訂的文檔的行尾?
您可以像這樣檢測使用哪個換行符
private SyntaxTrivia _detectLineBreakTrivia(SyntaxNode root)
{
var result = root.DescendantTokens()
.SelectMany(token => token.TrailingTrivia)
.FirstOrDefault(trivia => trivia.IsKind(SyntaxKind.EndOfLineTrivia));
if(Equals(result, default(SyntaxTrivia))
resut = SyntaxFactory.CarriageReturnLineFeed;
return result;
}
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.