Comments in grammar files

未关闭
  • 哪里不对？
#15 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
csharp
领域
compilers

调研方向

The payload names no source files, only Grammar.md for documentation and a test suite to add. Start by reading Grammar.md and the existing grammar parser to see where terminal sets, rules and pre-parsing instructions are read. Settle the comment syntax first, since the proposed *, ** and '* escape rules are not yet agreed. Done means comments parse at every listed position, with one test per position and a Grammar.md section.

由索引模型根据 Issue 内容生成。

描述

enhancement good first issue

There are currently no ways of writing comment in grammar files.

Here is an idea of where to insert comments

  • On every new line
  • After terminal or non terminal sets
  • After a rule or regular expression ending ;
  • After a pre-parsing instruction

There should also be a possibility to write comments on several lines. Here is what I propose to do so:

  • Use symbol * at any of the previously cited emplacement to start a one line comment
  • Use symbol ** at the start of a new line and at the end of a comment to enable multiline comments
  • Use escape character '* inside a comment to insert the character *.

Don't forget to

  • Add tests, one for all comments positions (see above).
  • Add comments documentation in Grammar.md.
主要语言
C#
星标
0
派生
0
平均合并
3 天 4 小时
30 天内合并 PR
5

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

Natvs/Nt.SyntaxParser 的其他 Issue

查看 Natvs/Nt.SyntaxParser 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。