Question

首先：这不是语法错误！我的语法文件不包含任何错误！ 我想为我的程序编写一个C＃语法。我从CodePlex下载了这个语法： ANTLR C# 4.0 Grammar 我没有为ANTLR 4找到更好的C＃语法。这个语法不支持对我的程序非常重要的文档注释。这个语法会跳过所有注释，所以我删除了文档注释的删除并编写了我的代码以便进行文档注释，但是我不知道怎么说，在“\ n”之后必须是“/// ”。我担心，当他识别出“\ n”时，词法分析器会自动跳过词法符号并且永远不会匹配：（'\ n''///'）？在我的解析器规则中。有谁知道，如何解决这个问题？或者任何人都可以向我解释，我的代码是正确的，如果是的话？

以下是文档注释的解析器规则：

//documentation comments
doc_comment :
'///' (  summary remarks?
        |remarks
        );
summary :
    '<summary' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* tag_body+ (('\n' '///')* comment_text ('\n' '///')*)* '</summary>';
remarks :
    '<remarks' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</remarks>';
tag_body :   '<c' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</c>'
            |'<code' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</code>'
            |'<example' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</example>'
            |'<exception' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</exception>'
            |'<include' 'file' '=' '\'' comment_text '\'' 'path' '=' '\'' comment_text ('[' '@name' '=' '"'identifier '"' ']')? '\'' '/' '>'
            |'<list' 'type' '=' ('"bullet"' | '"number"' | '"table"') '>' ('\n' '///')* listheader? listitem? '</list>' 
            |'<para' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</para>' 
            |'<param' 'name' '=' '"' identifier '"' '>' (('\n' '///')* comment_text ('\n' '///')*)* '</param>'
            |'<paramref' 'name' '=' '"' comment_text '"' '/' '>'
            |'<permission' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</permission>'
            |'<returns' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</returns>'
            |'<see' cref '/' '>'
            |'<seealso' cref '/' '>'
            |'<typeparam' 'name' '=' '"' comment_text '"' '>' (('\n' '///')* comment_text ('\n' '///')*)* '</typeparam>'
            |'<typeparamref' 'name' '=' '"' comment_text '"' '/' '>'
            |'<value' cref? '>' (('\n' '///')* comment_text ('\n' '///')*)* '</value>';
cref : 'cref' '=' '"' comment_text '"' ;
listheader : '<listheader>' ('<term>' (('\n' '///')* comment_text ('\n' '///')*)* '</term>')? ('<description>' (('\n' '///')* comment_text ('\n' '///')*)* '</description>')? '</listheader>';
listitem : '<listitem>' ('<term>' (('\n' '///')* comment_text ('\n' '///')*)* '</term>')? ('<description>' (('\n' '///')* comment_text ('\n' '///')*)* '</description>')? '</listitem>';

这里是白色空间的词法分析器规则（WS），comment_text的解析器规则和注释字符的词法分析器规则（ANY_CHARS）：

WS:
    (' '  |  '\r'  |  '\t'  |  '\n'  ) -> skip;
comment_text : ANY_CHARS;
fragment ANY_CHARS: (.)*;

感谢您的回复！

皮特

Answer 1

我确信理论上可以在文件的其余部分同时解析XML文档注释，但这是一个维护噩梦，特别是对于词法分析器规则。例如，您将如何处理以下内容？

/// <see
///      cref="Something"
/// />

您应该执行以下操作，而不是采用此方法。

将所有文档评论标记移至自己的频道。

@members {
    public const int DocCommentsChannel = 2;
}

DOC_COMMENT : '///' ~[\r\n]* -> channel(DocCommentsChannel);
LINE_COMMENT : '//' ~[\r\n]* -> channel(HIDDEN);

解析后，编写代码以检查ITokenStream通道上所有令牌实例的DocCommentsChannel，直到某个项目的声明为止，并将它们作为一个组进行处理。使用单独的解析器。通过从每行中删除前导///字符并将生成的文本块放置为<Comment>{Your comment text here}</Comment>等根元素的主体，可以通过创建注释的内存中XML表示来轻松执行此操作。。然后，您可以调用XDocument.Parse加载评论并根据需要从那里处理。

ANTLR 4中词法分析器和解析器规则中'\ n'的模糊引用

1 个答案: