Resharper Cheat Sheet

Posted : admin On 1/29/2022

Then hit a shortcut like Ctrl+Shift+N and a menu pops up saying there’s a conflict in shortcuts and asks which scheme do you want to use. Select “Visual Studio” or “Resharper 2.x or IntelliJ IDEA” and check the Apply to All. You can switch to the other schema at any time. Here’s an image for the visual studio layout. Mar 08, 2021 ReSharper provides two default keyboard shortcuts schemes. Visual Studio — This scheme aims to minimize conflicts with Visual Studio's own keyboard shortcuts. IntelliJ IDEA — This scheme shares the majority of shortcuts with those used in IntelliJ IDEA and its derivative web development IDEs. A cheat sheet for Agile as a PDF: Sure you’ve got the ReSharper 3.0 cheat sheet taped to your monitor, but what do you have that’s reminding you of values and principles? You need an Agile cheat sheet! Luckily I’ve got one for you right here! Print it out and put it in your team room, tack it to your task board, and tape it to your monitor.

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.

Yahoo fantasy football cheat sheets

ReSharper adds items to Visual Studio's keyboard settings dialog box. Go to: Tools - Options, Environment - Keyboard. In the search bar, type 'resharper' and see the vast options that you can control with the keyboard. 'Cheat Sheets' for both IntelliJ IDEA and Visual Studio default keyboard shortcuts schemes are available on the documents section on the official site. Direct links for the latest ReSharper version: ReSharper Default Keymap: Visual Studio scheme; ReSharper Default Keymap: ReSharper 2.x / IDEA scheme.

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 additional remarks 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>:

Resharper cheat sheet template

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 …“:

  • 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 type bool consider starting the description with “Specifies …“ (enum) or “Specifies whether …“ (bool)

  • Note: According to Clean Code you should not use bool method parameters.

Sheet

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.”:

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

Resharper keyboard shortcuts

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?


Rico Suter SOFTWARE ENGINEERING EDIT
Best PracticesXML Documentation.NETC#Cheat SheetClean CodeCoding GuidelinesDocumentation

Please enable JavaScript to view the comments powered by Disqus.

Resharper Cheat Sheet Template

CommandShortcut
(Visual Studio)
Shortcut
(IntelliJ IDEA/ReSharper 2.x)
Show available quick-fixes and context actionsAlt+EnterAlt+Enter
Paste multipleCtrl+Shift+V
Code cleanupCtrl+E, CCtrl+Alt+F
Silent code cleanupCtrl+E, FCtrl+Shift+Alt+F
Symbol code completionCtrl+SpaceCtrl+Space
Smart code completionCtrl+Alt+SpaceCtrl+Shift+Space
Import symbol completionShift+Alt+SpaceCtrl+Alt+Space
Complete statementCtrl+Shift+EnterCtrl+Shift+Enter
Parameter informationCtrl+Shift+SpaceCtrl+P
Quick documentationCtrl+Shift+F1Ctrl+Q
Insert live templateCtrl+E, LCtrl+J
Surround with templateCtrl+E, UCtrl+Alt+J
Generate codeAlt+InsertAlt+Insert
Create file from templateCtrl+Alt+InsertCtrl+Alt+Insert
Move code upCtrl+Shift+Alt+UpCtrl+Shift+Alt+Up
Move code downCtrl+Shift+Alt+DownCtrl+Shift+Alt+Down
Move code leftCtrl+Shift+Alt+LeftCtrl+Shift+Alt+Left
Move code rightCtrl+Shift+Alt+RightCtrl+Shift+Alt+Right
Extend selectionCtrl+Alt+RightCtrl+W
Shrink selectionCtrl+Alt+LeftCtrl+Shift+W
Duplicate a line or selectionCtrl+DCtrl+D
Comment with line commentCtrl+Alt+/Ctrl+/
Comment with block commentCtrl+Shift+/Ctrl+Shift+/
Inspect thisCtrl+Shift+Alt+ACtrl+Shift+Alt+A
Inspection Results windowCtrl+Alt+V
Turn code analysis on/offCtrl+Shift+Alt+8Ctrl+Shift+Alt+8

Resharper Shortcuts Cheat Sheet Intellij

Navigation and Search

CommandShortcut
(Visual Studio)
Shortcut
(IntelliJ IDEA/ReSharper 2.x)
Find Results windowCtrl+Alt+F12Ctrl+Alt+U
Hierarchies windowCtrl+Alt+H
View type hierarchyCtrl+E, HCtrl+Alt+H
File structureCtrl+Alt+FCtrl+F11
To-do itemsCtrl+Alt+D
Browse stack traceCtrl+E, TCtrl+Shift+E
Locate in Solution ExplorerShift+Alt+LShift+Alt+L
View recent filesCtrl+,Ctrl+E
View recent editsCtrl+Shift+,Ctrl+Shift+Alt+Backspace
Go to previous editCtrl+Shift+BackspaceCtrl+Shift+Backspace
Go to related filesCtrl+Alt+F7Ctrl+Shift+Alt+G
View bookmarksCtrl+`Ctrl+`
Go to bookmarkCtrl+[numeric key]Ctrl+[numeric key]
Set/remove bookmarkCtrl+Shift+[numeric key]Ctrl+Shift+[numeric key]
Go to typeCtrl+TCtrl+N
Go to fileCtrl+Shift+TCtrl+Shift+N
Go to file memberAlt+Ctrl+F12
Go to symbolShift+Alt+TCtrl+Shift+Alt+N
Navigate toAlt+`Ctrl+Shift+G
Go to type of symbolCtrl+Shift+F11Ctrl+Shift+T
Go to declarationF12Ctrl+B
Go to implementationCtrl+F12Ctrl+Shift+Alt+B
Go to base symbolsAlt+HomeCtrl+U
Go to derived symbolsAlt+EndCtrl+Alt+B
Go to usageShift+Alt+F12Ctrl+Alt+F7
Go to next member/tagAlt+DownAlt+Down
Go to previous member/tagAlt+UpAlt+Up
Go to next highlight (error, warning or suggestion)Alt+PgDnF12
Go to previous highlight (error, warning or suggestion)Alt+PgUpShift+F12
Go to next errorShift+Alt+PgDnAlt+F12
Go to next error in solutionShift+Alt+PgDnAlt+F12
Go to previous errorShift+Alt+PgUpShift+Alt+F12
Go to previous error in solutionShift+Alt+PgUpShift+Alt+F12
Go to containing declarationCtrl+[Ctrl+[
Find usagesShift+F12Alt+F7
Find usages (advanced)Ctrl+Shift+Alt+F12Shift+Alt+F7
Highlight usages in fileShift+Alt+F11Ctrl+Shift+F7
Go to previous usageCtrl+Alt+PgUpCtrl+Alt+Up
Go to next usageCtrl+Alt+PgDnCtrl+Alt+Down

Refactorings

CommandShortcut
(Visual Studio)
Shortcut
(IntelliJ IDEA/ReSharper 2.x)
Refactor thisCtrl+Shift+RCtrl+Shift+R
RenameCtrl+R, RF2 or Shift+F6
MoveCtrl+R, OF6
Safe deleteCtrl+R, D or Alt+DelAlt+Del
Extract methodCtrl+R, MCtrl+Alt+M
Introduce variableCtrl+R, VCtrl+Alt+V
Introduce fieldCtrl+R, FCtrl+Alt+D
Introduce parameterCtrl+R, PCtrl+Alt+P
Inline variable/method/fieldCtrl+R, ICtrl+Alt+N
Encapsulate fieldCtrl+R, ECtrl+R, Ctrl+E
Change signatureCtrl+R, SCtrl+F6

Resharper Cheat Sheets

Resharper cheat sheet intellij

Other

Resharper Cheat Sheet Excel

CommandShortcut
(Visual Studio)
Shortcut
(IntelliJ IDEA/ReSharper 2.x)
Unit Test ExplorerCtrl+Alt+UCtrl+Alt+T
Unit Test SessionsCtrl+Alt+TCtrl+Alt+R
Close recent toolCtrl+Shift+F4Ctrl+Shift+F4
Activate recent toolCtrl+Alt+BackspaceCtrl+Alt+Backspace