Free ebook on commenting

Yan Cui

I help clients go faster for less using serverless technologies.

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

Whenever you’re ready, here are 4 ways I can help you:

  1. Production-Ready Serverless: Join 20+ AWS Heroes & Community Builders and 1000+ other students in levelling up your serverless game. This is your one-stop shop for quickly levelling up your serverless skills.
  2. Do you want to know how to test serverless architectures with a fast dev & test loop? Check out my latest course, Testing Serverless Architectures and learn the smart way to test serverless.
  3. I help clients launch product ideas, improve their development processes and upskill their teams. If you’d like to work together, then let’s get in touch.
  4. Join my community on Discord, ask questions, and join the discussion on all things AWS and Serverless.

Leave a Comment

Your email address will not be published. Required fields are marked *