Home
Getting Started
Current Status
Documentation
- frostc
- Syntax
  - Keywords
  - Statements
    - Assignment
    - Method Calls
    - if
    - for
    - while
    - do
    - loop
    - break
    - continue
    - return
    - assert
    - unreachable
    - match
    - try
  - Expressions
  - Annotations
  - Comments
  - Documentation Comments
  - Error Handling
- Classes
  - Interfaces
  - Choices
  - Values
  - Immutability
  - Packages
    - Uses
  - Generics
  - Bare Code
- Methods
- Fields
- Types
- Variables and Constants
- Memory
  - Weak References
- Threads
API Documentation
- frostcollections Array Collection CollectionView CollectionWriter DefaultHashMap HashKey HashMap HashSet IdentityMap IdentitySet ImmutableArray Iterable Iterator List ListView ListWriter Map MapView MapWriter Stack core Bit Char16 Char32 Char8 Comparable Equatable Error Formattable Immutable Int Int16 Int32 Int64 Int8 Matcher Maybe MutableString Index MutableValue Object Range Real32 Real64 RegularExpression SteppedRange String Index Match System Process UInt UInt16 UInt32 UInt64 UInt8 Value Weak io ByteOrder Console File IndentedOutputStream InputStream LineNumberInputStream MemoryInputStream MemoryOutputStream OutputStream PushbackInputStream math Random XorShift128Plus threads Lock MessageQueue Notifier ScopedLock Thread time Timer unsafe Pointer UnsafeMessageQueue

Comments

Frost supports three different styles of comments:

Line comments

Two hyphens in a row (--) begin a line comment, causing the rest of the line to be ignored:

var x:Int -- initialized in the constructor

Block comments

A hyphen followed by an asterisk (-) begins a block comment, and the opposite sequence (-) ends the block comment:

-* Output the final results
 * Need to do some better formatting in the future
 *-
Console.printLine(result)

It is legal to nest block comments.

Documentation comments

Three or more equals signs (===) begin and end a documentation comment. Documentation comments are special comments that must appear immediately prior to a class, method, or field, and provide a formal description of the class, method, or field they precede.

===================================================
Appends a character to the end of the string.

@param c the character to append
===================================================
method append(c:Char) {
    ...
}

Documentation comments are described in more detail on the documentation comments page. Documentation comments in Frost, unlike in many other languages, are actually part of the language's grammar and thus may not appear anywhere but immediately before a class, method, or field.