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.

Advertisements

About Andras Nemes
I'm a .NET/Java developer living and working in Stockholm, Sweden.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

ultimatemindsettoday

A great WordPress.com site

Elliot Balynn's Blog

A directory of wonderful thoughts

Robin Sedlaczek's Blog

Developer on Microsoft Technologies

Softwarearchitektur in der Praxis

Wissenswertes zu Webentwicklung, Domain-Driven Design und Microservices

Technology Talks

on Microsoft technologies, Web, Android and others

Software Engineering

Web development

Disparate Opinions

Various tidbits

chsakell's Blog

WEB APPLICATION DEVELOPMENT BEST PRACTICES WITH MICROSOFT STACK & ANGULAR

Cyber Matters

Bite-size insight on Cyber Security for the not too technical.

Guru N Guns's

OneSolution To dOTnET.

Johnny Zraiby

Measuring programming progress by lines of code is like measuring aircraft building progress by weight.

%d bloggers like this: