Updated manual

This commit is contained in:
Mattia Giambirtone 2022-12-15 15:52:04 +01:00
parent 42a7c4d050
commit 3a48999a35
2 changed files with 18 additions and 1 deletions

View File

@ -13,6 +13,7 @@ Peon is a modern, multi-paradigm, async-first programming language with a focus
declarations as well as the bytecode used by the compiler
- `src/frontend/compiler` -> Contains the compiler and its various compilation targets
- `src/frontend/compiler/targets` -> Contains compilation targets
- `src/frontend/parsing` -> Contains the tokenizer and parser
- `src/backend/` -> Contains the various backends supported by peon (bytecode, native)
- `src/util/` -> Contains utilities such as the bytecode debugger and serializer as well
as procedures to handle multi-byte sequences
@ -39,7 +40,6 @@ Other notable features are the ability to define (and overload) custom operators
In peon, all objects are first-class: this includes functions, iterators, closures and coroutines.
## Disclaimers
**Disclaimer**: The project is still in its very early days: lots of stuff is not implemented, a work in progress or

View File

@ -59,6 +59,23 @@ __Note__: Peon supports [name stropping](https://en.wikipedia.org/wiki/Stropping
that almost any ASCII sequence of characters can be used as an identifier, including language
keywords, but stropped names need to be enclosed by matching pairs of backticks (`\``)
### Comments
```
# This is a single-line comment
# Peon has no specific syntax for multi-line comments.
fn id[T: any](x: T): T {
## Documentation comments start
## with two dashes. They are currently
## unused, but will be semantically
## relevant in the future. They can
## be used to document types, modules
## and functions
return x;
}
```
### Functions
```