Comments and doc comments

Comments

You can and should add comments to your Slice files to make your Slice definitions easier to understand.

A Slice comment starts with two slashes (//) and continues until the end of the line, just like in C# and Rust:

// This is a comment
interface FooBar { // This is another comment
}

Slice also supports block comments (/* ... */), like C. Block comments cannot be nested.

The Slice compiler completely ignores comments that are not doc comments.

Doc comments

Slice comments that start with a triple slash (///) are doc comments. The Slice code generators use these special comments as input for the doc comments they generate in the mapped languages.

Slice doc comments can be attached to all Slice elements except parameters and modules.

Doc comment tags

Slice doc comments support the following tags:

Example

module Example

/// Represents a factory for widgets.
/// @see Widget
interface WidgetFactory {
    /// Creates a new {@link Widget}.
    /// @param name: The name of the new widget.
    /// @returns: The new widget.
    createWidget(name: string) -> Widget

    /// Retrieves the last {@link Widget} created by this factory.
    /// @returns widget: A copy of the last widget.
    /// @returns timeStamp: The creation time stamp.
    getLastWidget() -> (widget: Proxy, timeStamp: WellKnownTypes::TimeStamp)
}