Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #30

Open
thinker227 opened this issue Jun 30, 2024 · 0 comments
Open

Documentation #30

thinker227 opened this issue Jun 30, 2024 · 0 comments

Comments

@thinker227
Copy link
Owner

thinker227 commented Jun 30, 2024

Allow doc comments above variables and functions which are available on the node and symbol as well as displayed in Intellisense. Doc comments should likely start with /// and can contain simple markdown.

/// This is a doc comment for `x`. 
let x = 0;

/// This is a doc comment for `f`. 
/// It always returns [`x`]. 
func f() => x;

For a non-hacky implementation, a concrete syntax tree (#29) would be quite useful before implementing this. This could already be implemented though since some tokens exist in the AST, and doc comments should only be able to appear on eg. let and func tokens. Still need whitespace in tokens though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant