Free ebook on commenting

You can become a serverless blackbelt. Enrol in my course Learn you some Lambda best practice for great good! and learn best practices for performance, cost, security, resilience, observability and scalability. By the end of this course, you should be able to make informed decisions on which AWS service to use with Lambda and how to build highly scalable, resilient and cost efficient serverless applications.

Stumbled across ic#code‘s free ebook ‘The fine art of commenting’ this morning, it’s from 2002 but everything still applies, you can download it here.

The book covers commenting in general and not just C#, but in relation to C# here’s the list of the predefined xml tags you can use in comments (something I have to search every time..):

<c> Marks a part of a comment to be formatted as code
<code> As above, but multiline
<example> For embedding examples in comments, usually uses <c>
<exception>* Documents an Exception class
<include>* Includes documentation from other files
<list> A list of <term>s defined by <description>s
<para> Structures text blocks, e.g. in a <remark>
<param>* Describes a method parameter
<paramref>* Indicates that a word is used as reference to a parameter
<permission>* Gives the access permissions to a member
<remarks> For overview of what a given class or other type does
<returns> Description of the return value
<see>* Refers to a member or field available
<seealso>* As above, but displays a ‘See also’ section
<summary> A summary of the object
<value> Describes a property

* validated by the C# compiler

Liked this article? Support me on Patreon and get direct help from me via a private Slack channel or 1-2-1 mentoring.
Subscribe to my newsletter


Hi, I’m Yan. I’m an AWS Serverless Hero and the author of Production-Ready Serverless.

I specialise in rapidly transitioning teams to serverless and building production-ready services on AWS.

Are you struggling with serverless or need guidance on best practices? Do you want someone to review your architecture and help you avoid costly mistakes down the line? Whatever the case, I’m here to help.

Hire me.


Check out my new podcast Real-World Serverless where I talk with engineers who are building amazing things with serverless technologies and discuss the real-world use cases and challenges they face. If you’re interested in what people are actually doing with serverless and what it’s really like to be working with serverless day-to-day, then this is the podcast for you.


Check out my new course, Learn you some Lambda best practice for great good! In this course, you will learn best practices for working with AWS Lambda in terms of performance, cost, security, scalability, resilience and observability. We will also cover latest features from re:Invent 2019 such as Provisioned Concurrency and Lambda Destinations. Enrol now and start learning!


Check out my video course, Complete Guide to AWS Step Functions. In this course, we’ll cover everything you need to know to use AWS Step Functions service effectively. There is something for everyone from beginners to more advanced users looking for design patterns and best practices. Enrol now and start learning!


Are you working with Serverless and looking for expert training to level-up your skills? Or are you looking for a solid foundation to start from? Look no further, register for my Production-Ready Serverless workshop to learn how to build production-grade Serverless applications!

Find a workshop near you