Comments in grammar files

Offen
  • Stimmt etwas nicht?
#15 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
csharp
Bereich
compilers

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.
Vorherrschende Sprache
C#
Sterne
0
Forks
0
Ø Merge
3 T. 4 Std.
Gemergte PRs (30 T.)
5

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Natvs/Nt.SyntaxParser

Alle Issues in Natvs/Nt.SyntaxParser

Ähnliche Issues

Weitere Issues zu C#

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.