Comments in grammar files

Đang mở
  • Có gì không ổn?
#15 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
csharp
Lĩnh vực
compilers

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
C#
Star
0
Fork
0
Merge trung bình
3 ngày 4 giờ
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Natvs/Nt.SyntaxParser

Tất cả issue của Natvs/Nt.SyntaxParser

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.