Resharper: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
Zur Navigation springen Zur Suche springen
(typos, grammar)
 
(36 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
{{UEA|Dietsch|Fehlende Sektionen müssen noch ausgefüllt werden.}}
{{TOCRight}}
== Was ist Resharper? ==
 
[[Resharper|ReSharper]] ist eine von  von [http://www.jetbrains.com/ JetBrains] entwickelte Erweiterung für Microsoft [[Visual Studio]] für die Sprachen {{CSharp}} oder Visual Basic .NET.  
[[Resharper|ReSharper]] ist eine von  von [http://www.jetbrains.com/ JetBrains] entwickelte Erweiterung für Microsoft [[Visual Studio]] für die Sprachen {{CSharp}} oder Visual Basic .NET.  


Die wichtigsten Features von [[Resharper]] sind:
Die wichtigsten Features von [[Resharper]] sind:
* Die Einhaltung von [[Coding Conventions]] werden automatisch und Client-seitig überprüft. [[Coding Conventions]] sind in [[Resharper]] frei konfigurierbar, Verletzungen können als Hinweis, Warnung oder Fehler angezeigt werden. Im Softwarepraktikum stellen wir eine Konfigurationsdatei bereit (zur Installation siehe Abschnitt [[#Konfiguration|Konfiguration]], die einheitliche [[Coding Conventions]] für alle Gruppen definiert.  
* Die Einhaltung von [[Coding Conventions]] werden automatisch und Client-seitig überprüft. [[Coding Conventions]] sind in [[Resharper]] frei konfigurierbar, Verletzungen können als Hinweis, Warnung oder Fehler angezeigt werden. Im Softwarepraktikum stellen wir eine Konfigurationsdatei bereit (zur Installation siehe Abschnitt [[#Konfiguration|Konfiguration]]), die einheitliche [[Coding Conventions]] für alle Gruppen definiert.
* Verschiedene Werkzeuge zur statischen Analyse des Programcodes. Dafür markiert [[Resharper]] schon im Quelltext on-the-fly Fehler oder potentielle Fehlerquellen, wie z.B. ungenutzte Felder oder unerreichbare Pfade. Für sehr viele Arten von Fehlern, Warnungen oder Unschönheiten bietet er außerdem automatische Korrekturmöglichkeiten an, so dass lästige Arbeiten, wie zum Beispiel das Hinzufügen von Using-Direktiven, automatisch vorgenommen werden können.
* Verschiedene Werkzeuge zur statischen Analyse des Programmcodes. Dafür markiert [[Resharper]] schon im Quelltext on-the-fly Fehler oder potentielle Fehlerquellen, wie z.B. ungenutzte Felder oder unerreichbare Pfade. Für sehr viele Arten von Fehlern, Warnungen oder Unschönheiten bietet er außerdem automatische Korrekturmöglichkeiten an, sodass lästige Arbeiten, wie zum Beispiel das Hinzufügen von Using-Direktiven, automatisch vorgenommen werden können.
* Verschiedene Arten von Refactoring, wie z.B. Methoden extrahieren oder Methoden in der Vererbungshierarchie verschieben. Es können auch ganze Code-Bausteine oder Fragmente erzeugt werden.  
* Verschiedene Arten von Refactoring, wie z.B. Methoden extrahieren oder Methoden in der Vererbungshierarchie verschieben. Es können auch ganze Code-Bausteine oder Fragmente erzeugt werden.
* Zusätzlich erweitert [[Resharper]] bereits vorhandene Werkzeuge von [[Visual Studio]], wie z.B. IntelliSense und die Codevervollständigung, um viele Funktionen.
* Zusätzlich erweitert [[Resharper]] bereits vorhandene Werkzeuge von [[Visual Studio]], wie z.B. IntelliSense und die Codevervollständigung, um viele Funktionen.


== Setup ==  
==Setup==  
=== Installation ===  
 
Um ReSharper auf Ihrem Computer zu installieren gehen Sie wie folgt vor:
{{:Resharper_Installieren}}
# Sie müssen [[Visual Studio]] bereits installiert und einmal gestartet haben.
 
# Laden Sie die [http://www.jetbrains.com/resharper/download/index.html Resharper] 30-Tage Demo für Visual Studio herunter (Version 6.x.x).
==Verwendung==
# Folgen Sie den Installationsanweisungen des Programs.
 
# Starten Sie Visual Studio. Beim Start wird nach einem Benutzernamen und einem Lizenzschlüssel gefragt, den Sie zu Beginn des Praktikums (nach der Gruppeneinteilung) per Mail erhalten haben. Tragen Sie diese Daten hier ein.
===Hints, Suggestions, Warnings und Errors in Solution===
# Eventuell werden Sie auch nach einem Keyboard-Shortcut-Schema gefragt. Wir empfehlen Ihnen, das Visual Studio Preset zu behalten.  
{{RefImg|FensterReSharper.png|500px|1|Anzeige der Nachrichten am horizontalen Scrollbalken (grüner Pfeil) und Kontextmenüsymbol für Optionen zu einer Nachricht (lila Pfeil).}}
[[Datei:Visual Studio Code Issue Anzeige Einstellungen.png|mini|Bei C# sollten alle Haken gesetzt sein, damit die Resharper Fehler im Code Issue Log auch angezeigt werden.]]


=== Konfiguration ===
[[Resharper]] analysiert die gesamte Solution und zeigt basierend auf sehr vielen Regeln diverse Nachrichten an, die verschiedene Schwachstellen des Codes aufzeigen sollen. Diese Nachrichten werden in 4 verschiedene Klassen eingeteilt, nämlich Hints, Suggestions, Warnings und Errors. Der Benutzer kann in [[Visual Studio]] die Nachrichten auf zwei Arten einsehen:
Nach der Installation müssen Sie noch die für das Softwarepraktikum notwendigen Einstellungen installieren. Dazu gehen Sie wie folgt vor:
* Durch ein spezielles Fenster, dass durch das Menü <tt>ReSharper -> Inspect -> Code Issues in Solution</tt> erreicht werden kann. Stellen Sie sicher, dass im Fenster <code>Code Issues unter Filter -> Issues to show -> C#</code> alle Haken gesetzt sind (siehe Bild).
# In Ihrem Repository finden Sie die Datei <tt>/trunk/doc/Softwarepraktikum.DotSettings</tt>. Falls Sie gerade keinen Zugriff auf Ihr Repository haben, können Sie diese Datei auch hier herunterladen: [[Datei:Sopra-Resharper.zip]]. In diesem Fall müssen Sie die das .zip noch an einen Ort Ihrer Wahl entpacken.
* Durch kleine Striche direkt neben dem horizontalen Scrollbalken (siehe {{LinkImg|1|Abbildung 1}}) in einem der Code-Editor-Fenster. Die Farbe der Striche gibt dabei die Art der jeweiligen Nachricht an.
# Öffen Sie in [[Visual Studio]] das Menü <tt>ReSharper -> Manage Options...</tt>.
# Klicken Sie rechts auf das Item <tt>This Computer</tt> und wählen Sie <tt>Add Layer->Open Settings File...</tt>.
# Wählen Sie die Datei <tt>Softwarepraktikum.DotSettings</tt> aus. Diese sollte nun als Eintrag "Softwarepraktikum" vorhanden sein.


== Verwendung ==
Wenn auf einen Eintrag in dem Fenster bzw. auf einen der Striche geklickt wird, springt der Cursor automatisch an die entsprechende Stelle im Code und auf der linken Seite erscheint ein kleines Kontextmenüsymbol (siehe {{LinkImg|1|Abbildung 1}}), das durch einen weiteren Klick Optionen zur Behandlung des aktuellen Problems anbietet. Dieses Symbol erscheint auch, wenn man den Cursor manuell auf eine Programmstelle setzt, für die [[Resharper]] Nachrichten hat.  
{{BA|Dietsch|Einmal ein Eintrag mit Screenshots zu den "Resharper->Inspect->Code Issues in Solution" und wie man die interpretiert (also Hint, Suggestion, Warning, Error) (vlt. auch mit den Zeichen am Rand). Mittlerweile ist die Solution-Wide Analysis auch Teil der Einstellungen die wir ihnen direkt geben, musst dazu also nichts sagen}}
{{BA|Dietsch|Einmal ein Eintrag zum Refactoring mit Resharper, so Richtung "auf symbol klicken, im Kontextmenü schauen" und dann mal sehen obs eine schöne Übersicht auf der Resharper Seite gibt oder kurz die (wichtigsten) Möglichkeiten beschreiben}}
{{BA|Dietsch|Und einmal einen Eintrag zum Kontextmenü "Inspect", da gibts 5 Einträge abhängig vom Symbol, die mal kurz beschreiben.}}


{{RefImg|GrauerPunkt.png|600px|1|Aktivierung der Solution Wide Analysis.}}
<br clear="all">
{{RefImg|RoterPunkt.png|600px|2|Fehlerzustand.}}
=== Kontextmenü "Refactoring"===
Um die "Solution Wide Analysis" zu aktivieren kann man ganz rechts unten auf den grauen Punkt doppleklicken (Siehe Abbildung, blauer Pfeil). Daraufhin wird der Punkt entweder Grün oder Rot, je nach Fehlerzustand (siehe Abbildung, roter Pfeil). Jetzt werden einem durch einem weiteren Doppelklick eine Liste mit den Fehlern der Solution angezeigt. Alternativ kann man auch das Fenster unter "ReSharper>Inspect>Code Issues in Solution" verwenden.
{{RefImg|ReSharperRefactor.png|500px|1|Kontextmenu "Refactoring".}}
Klickt man im Programmtext auf ein Symbol, wie etwas eine Variable mit der rechten Maustaste erscheint ein Kontextmenü, in dem sich unter anderem der Punkt <tt>Refactor</tt> befindet. Darunter finden sich mehrere Optionen:
*'''Refactor this...''' zeig alle Möglichkeiten an.
*'''Inline''' Wenn man eine Variable ausgewählt hat kann man sie inlinen
*'''Rename''' Variablen können hiermit in der gesamten Solution umbenannt werden
*'''Extract Method''' Wenn man einen Programm-Block auswählt, kann man diesen in eine Methode extrahieren
*'''Push/Pull members Up/Down''' Hiermit können Methoden in der Vererbungshierarchie verschoben werden
Es gibt noch weitere Funktionen die z.B. unter dem Punkt "Convert" zu finden sind.  
<br clear="all">
<br clear="all">


{{RefImg|FensterReSharper.png|600px|3|Fehlerbalken und Refactoring.}}
===Kontextmenü "Inspect"===
{{RefImg|Braun.png|600px|4|Refactoring.}}
{{RefImg|ReSharperInspect.png|500px|1|Kontextmenu "Inspect".}}
Eine sehr bequeme Methode ist auch der Fehlerbalken am rechten Rand (Siehe Abbildung, grüner Pfeil).
Außerdem gibt es in dem Kontextmenü, das man erhält, wenn man auf ein Programmsymbol rechts klickt die Möglichkeit zur Analyse:
Relativ zum horizontalen Scrollbalken befinden sich rechts daneben für jeden Hinweis, Warnung oder Fehler, jeweils ein grüner, oranger oder roter Balken.  
*'''Inspect This...''' Zeigt alle möglichen Optionen an
Durch Klick wird an die entsprechende Stelle gesprungen und es erscheint auf der linken Seite ein Glühbirnen-Symbol (Siehe Abbildung, lila Pfeil) oder ein violettes Tetraeder-Symbol (siehe Abbildung, brauner Pfeil). Dieses Symbol erscheint ebenfalls, wenn man den Cursor auf Programmtext setzt, der vom ReSharper markiert wird.
*'''Type Hierarchy''' Zeigt die Hierarchie innerhalb der Vererbung
Klickt man nun auf das Glühbirnen- bzw. Tetraeder-Symbol macht der ReSharper Vorlschläge zum automatisierten Beheben der Probleme. Alternativ kann man im Menu unter "ReSharper>Refactor>..." eine Option auswählen.
*'''Outgoing Calls''' Zeigt, welche Methoden von hier aus aufgerufen werden
*'''Incoming Calls''' Zeigt, an welchen anderen Stellen diese Methode aufgerufen wird
*'''Value Origin''' Zeigt auf, wo der Wert einer Variablen zugewiesen wurde
*'''Value Destination''' Zeigt wo der Wert der Variablen verbraucht wird


<br clear="all">
<br clear="all">


== Nützliche Informationen ==  
==Nützliche Informationen==  
* [http://www.jetbrains.com/resharper/webhelp/Introduction__Index.html Online Hilfe]
*[http://www.jetbrains.com/resharper/webhelp/Introduction__Index.html Online Hilfe]
* [http://www.jetbrains.com/resharper/webhelp/Reference__Keyboard_Shortcuts.html Standard Keyboard Shortcuts]
*[http://www.jetbrains.com/resharper/webhelp/Reference__Keyboard_Shortcuts.html Standard Keyboard Shortcuts]
 


[[Kategorie:Tools]]
[[Kategorie:Tools]]

Aktuelle Version vom 19. Oktober 2021, 09:49 Uhr

ReSharper ist eine von von JetBrains entwickelte Erweiterung für Microsoft Visual Studio für die Sprachen C# oder Visual Basic .NET.

Die wichtigsten Features von Resharper sind:

  • Die Einhaltung von Coding Conventions werden automatisch und Client-seitig überprüft. Coding Conventions sind in Resharper frei konfigurierbar, Verletzungen können als Hinweis, Warnung oder Fehler angezeigt werden. Im Softwarepraktikum stellen wir eine Konfigurationsdatei bereit (zur Installation siehe Abschnitt Konfiguration), die einheitliche Coding Conventions für alle Gruppen definiert.
  • Verschiedene Werkzeuge zur statischen Analyse des Programmcodes. Dafür markiert Resharper schon im Quelltext on-the-fly Fehler oder potentielle Fehlerquellen, wie z.B. ungenutzte Felder oder unerreichbare Pfade. Für sehr viele Arten von Fehlern, Warnungen oder Unschönheiten bietet er außerdem automatische Korrekturmöglichkeiten an, sodass lästige Arbeiten, wie zum Beispiel das Hinzufügen von Using-Direktiven, automatisch vorgenommen werden können.
  • Verschiedene Arten von Refactoring, wie z.B. Methoden extrahieren oder Methoden in der Vererbungshierarchie verschieben. Es können auch ganze Code-Bausteine oder Fragmente erzeugt werden.
  • Zusätzlich erweitert Resharper bereits vorhandene Werkzeuge von Visual Studio, wie z.B. IntelliSense und die Codevervollständigung, um viele Funktionen.

Setup

  • Erstellen Sie sich einen Account bei Jetbrains. Verwenden Sie ihre ...uni-freiburg.de E-Mail-Adresse, damit sie eine kostenlose Lizenz erhalten. Wenn Sie nicht sofort eine Lizenz erhalten, gehen Sie auf folgende Seite und beantragen die Lizenz explizit.
  • Laden Sie Resharper herunter und führen Sie die Installation aus.
  • Laden Sie die Sopra-spezifischen Resharper Einstellungen herunter und entpacken Sie diese.
  • Öffnen Sie in Visual Studio Extensions -> ReSharper -> Manage Options.
  • Klicken Sie rechts auf das Item This Computer und wählen Sie Add Layer -> Open Settings File....
  • Wählen Sie die Datei Softwarepraktikum.DotSettings aus. Diese sollte nun als Eintrag "Softwarepraktikum" vorhanden sein.

Verwendung

Hints, Suggestions, Warnings und Errors in Solution

Abbildung 1: Anzeige der Nachrichten am horizontalen Scrollbalken (grüner Pfeil) und Kontextmenüsymbol für Optionen zu einer Nachricht (lila Pfeil).
Bei C# sollten alle Haken gesetzt sein, damit die Resharper Fehler im Code Issue Log auch angezeigt werden.

Resharper analysiert die gesamte Solution und zeigt basierend auf sehr vielen Regeln diverse Nachrichten an, die verschiedene Schwachstellen des Codes aufzeigen sollen. Diese Nachrichten werden in 4 verschiedene Klassen eingeteilt, nämlich Hints, Suggestions, Warnings und Errors. Der Benutzer kann in Visual Studio die Nachrichten auf zwei Arten einsehen:

  • Durch ein spezielles Fenster, dass durch das Menü ReSharper -> Inspect -> Code Issues in Solution erreicht werden kann. Stellen Sie sicher, dass im Fenster Code Issues unter Filter -> Issues to show -> C# alle Haken gesetzt sind (siehe Bild).
  • Durch kleine Striche direkt neben dem horizontalen Scrollbalken (siehe Abbildung 1) in einem der Code-Editor-Fenster. Die Farbe der Striche gibt dabei die Art der jeweiligen Nachricht an.

Wenn auf einen Eintrag in dem Fenster bzw. auf einen der Striche geklickt wird, springt der Cursor automatisch an die entsprechende Stelle im Code und auf der linken Seite erscheint ein kleines Kontextmenüsymbol (siehe Abbildung 1), das durch einen weiteren Klick Optionen zur Behandlung des aktuellen Problems anbietet. Dieses Symbol erscheint auch, wenn man den Cursor manuell auf eine Programmstelle setzt, für die Resharper Nachrichten hat.


Kontextmenü "Refactoring"

Abbildung 1: Kontextmenu "Refactoring".

Klickt man im Programmtext auf ein Symbol, wie etwas eine Variable mit der rechten Maustaste erscheint ein Kontextmenü, in dem sich unter anderem der Punkt Refactor befindet. Darunter finden sich mehrere Optionen:

  • Refactor this... zeig alle Möglichkeiten an.
  • Inline Wenn man eine Variable ausgewählt hat kann man sie inlinen
  • Rename Variablen können hiermit in der gesamten Solution umbenannt werden
  • Extract Method Wenn man einen Programm-Block auswählt, kann man diesen in eine Methode extrahieren
  • Push/Pull members Up/Down Hiermit können Methoden in der Vererbungshierarchie verschoben werden

Es gibt noch weitere Funktionen die z.B. unter dem Punkt "Convert" zu finden sind.

Kontextmenü "Inspect"

Abbildung 1: Kontextmenu "Inspect".

Außerdem gibt es in dem Kontextmenü, das man erhält, wenn man auf ein Programmsymbol rechts klickt die Möglichkeit zur Analyse:

  • Inspect This... Zeigt alle möglichen Optionen an
  • Type Hierarchy Zeigt die Hierarchie innerhalb der Vererbung
  • Outgoing Calls Zeigt, welche Methoden von hier aus aufgerufen werden
  • Incoming Calls Zeigt, an welchen anderen Stellen diese Methode aufgerufen wird
  • Value Origin Zeigt auf, wo der Wert einer Variablen zugewiesen wurde
  • Value Destination Zeigt wo der Wert der Variablen verbraucht wird


Nützliche Informationen