Comments in grammar files

Ouverte
  • Quelque chose ne va pas ?
#15 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
csharp
Domaine
compilers

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.
Langage dominant
C#
Étoiles
0
Forks
0
Merge moyen
3 j 4 h
PR mergées (30 j)
5

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Natvs/Nt.SyntaxParser

Toutes les issues de Natvs/Nt.SyntaxParser

Issues similaires

Plus d'issues C#

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.