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 3 ways I can help you:
- Production-Ready Serverless: Join 20+ AWS Heroes & Community Builders and 1000+ other students in levelling up your serverless game.
- Consulting: If you want to improve feature velocity, reduce costs, and make your systems more scalable, secure, and resilient, then let’s work together and make it happen.
- Join my FREE Community on Skool, where you can ask for help, share your success stories and hang out with me and other like-minded people without all the negativity from social media.