search

Draco-lang / Language-suggestions

Collecting ideas for a new .NET language that could replace C#
75 stars 5 forks source link

RFC0009 - Documentation comments #102

Closed Binto86 closed 1 year ago

Binto86 commented 2 years ago

Specified documentation comments.

Kuinox commented 2 years ago

I have an issue with the structure of the documentation. I'd prefer if we splitted "regular" comments (we should drop the regular part), and documentation comment. Documentation comments are comments, therefor I recommend that we split the specs in two.

A spec for the comments, and a separated spec (so separated file) for the documentation comments, specifying that documentation comments are a subset of comments.

I also recommend to inspirate heavily the structure of their specs: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/lexical-structure#633-comments It's easy to read, and you understand easily. The c# documentation comments specs is the opposite.