C♯ Minor Cheat Sheet. All Cheat Sheets. (F#, C#, G#, and D#). It is the 9th most popular key among Minor keys and the 17th most popular among all keys. Minor keys, along with major keys, are a common choice for popular music. The three most important chords, built off the 1st, 4th and 5th scale degrees are all minor chords (C♯ minor, F. C# is pronounced 'C-Sharp'. It is an object-oriented programming language created by Microsoft that runs on the.NET Framework. C# has roots from the C family, and the language is close to other popular languages like C and Java.
- Download the most complete WinAppDriver C# cheat sheet. All you need to know – from basic to the most advanced configurations.
- Sharp Key Signatures – CHEAT SHEET 1. How to identify SHARP Key Signatures There are several ways of identifying a song's key using Sharp Key Signatures The simplest way is to locate the last sharp in the key signature (furthest right), and simply go up a minor 2nd, or half step. Remember that the letter name of the pitch MUST change!
- C# is pronounced 'C-Sharp'. It is an object-oriented programming language created by Microsoft that runs on the.NET Framework. C# has roots from the C family, and the language is close to other popular languages like C and Java.
The XML documentation tags of C# are described very well in the MSDN. However, the article does not explain how the contained phrases and sentences should be written. This article tries to fill this gap by providing rules and some sample phrases.
I recommend using StyleCop because its rules enforce some of the XML documentation recommendations from this article. Also check out the Visual Studio extension GhostDoc which automates and simplifies the writing of XML documentation.
General
- All XML documentation phrases should end with a period (.) and no blank:
- The
summary
tags should only contain the most important information. For further details use an additionalremarks
tag. To avoid having too much documentation in your source code files, read this article which explains how to “outsource” documentation to an external file.
Classes
- Each class should have a
summary
tag describing its responsibility. The summary often starts with “Represents …“ or “Provides …“ but other forms also exist:
Constructors
- The documentation of a constructor should be in the form “Initializes a new instance of the <see cref=”TYPENAME”/> class.”</see>:
Properties
- The summary of a property should start with “Gets or sets …“ if it is fully accessible, with “Gets …“ when the property is read-only, and with “Sets …“ if it is write-only:
- Note: According to the very recommended book Framework Design Guidelines, write-only properties should not be used at all.
- A property of type
bool
should start with “Gets or sets a value indicating whether …“:
Events
- Each event should have a
summary
tag which starts with the words “Occurs when …“: Obsidian markdown guide. - Note: Events should be named with a verb or verb phrase. Use the present and past tenses to express if the delegate is invoked before (e.g.
Closing
) or after (e.g.Closed
) a particular event.
Methods
- Like the method name itself, the text in the
summary
tag should start with a verb:
Method parameters
- Each method parameter should have a corresponding
param
tag containing a description of the parameter: - If the parameter is an
enum
or of typebool
consider starting the description with “Specifies …“ (enum) or “Specifies whether …“ (bool) - Note: According to Clean Code you should not use
bool
method parameters.
Method return value
- If the method returns a value, you should add a
returns
tag which contains a description of the returned object: - If the returned value is of type
bool
the documentation should be in the form “true if CONDITION; otherwise,false .”:
C Sharp Cheat Sheet Pdf
Exceptions
- The exception
exception
tag contains the reason why the exception occurred: - Tip: Have a look at Exceptional for ReSharper which greatly helps creating XML documentation for exceptions.
Final words
The rules in this articles are used in StyleCop and in the .NET Framework, therefore I think using them is best practice. Because it looks more clean to me, I write the opening tag, content and closing tag on a single line. Of course you can write them on multiple lines as proposed by the Visual Studio templates. For the generated XML documentation file it does not matter what style you are using.
What do you think about the described XML documentation rules? Are some rules missing in this list?
C Sharp Cheat Sheets
Rico Suter SOFTWARE ENGINEERING EDIT
Best PracticesXML Documentation.NETC#Cheat SheetClean CodeCoding GuidelinesDocumentation
Best PracticesXML Documentation.NETC#Cheat SheetClean CodeCoding GuidelinesDocumentation