Comments in grammar files

オープン
#15 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR(30日)
5

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Natvs/Nt.SyntaxParser のほかの issue

Natvs/Nt.SyntaxParser の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。