Code comments in F#

F# uses the double-slash for single line comments like in many other popular programming languages:

//this is a single line comment

You might expect that /* … */ would work for multi-line comments but there’s a slight variation to that:

(* 
        This is a multi line
        comment
        in F#
*)

So instead of the slash we need to put a pair of parentheses.

Commenting a function for documentation and IntelliSense purposes works just like in C#. Here’s an example with a dummy function:

    /// <summary>
    /// This function doesn't do anything really, just returns an empty string
    /// </summary>
    /// <param name="base64encode">Base64 encode or not</param>
    /// <param name="maxSize">Maximum size</param>
    /// <returns>An empty string for the time being</returns>
    /// <exception cref="System.ArgumentException">Thrown when the max size is 0</exception>
    let buildContent (base64encode:bool, maxSize:int) =
        ""

The consumer of the function will then get this information in a popup window in Visual Studio.

View all F# related articles here.