Motivation

Als ich mich einem neuen Projekt anschloss, hatte ich große Probleme herauszufinden, wo es definiert war, voller Methoden. Um schnell aufholen zu können, hielt ich "die Fähigkeit, schnell zu untersuchen und zu verstehen" für sehr wichtig, und bat leitende Ingenieure, dies zusammenzufassen. Die Überprüfung hat Vor- und Nachteile.

Für im Projekt definierte Methoden

1. `git grep -n <Methodenname>`

Es ist leichter zu sehen, da es im Terminal in Farbe angezeigt wird als die Volltextsuche des Editors.
Die Zeilennummer wird mit der Option -n hinzugefügt. Klicken Sie also auf Befehl + Pfad, um sie im Editor zu öffnen.
Nachteil: Suche nach Zeichenketten. Es gibt ziemlich viele Treffer. Wenn Sie "def method name" verwenden, wird dieser etwas eingegrenzt.

2. Betreten Sie das Suchfenster von Github mit einem Browser und suchen Sie nach "in diesem Repository".

Diese Methode hat das gleiche Ergebnis wie 1. Die oberen und unteren Zeilen des übereinstimmenden Teils werden jedoch auch zusammen angezeigt.
Gut, wenn Sie den Editor nicht verwenden möchten
Nachteil: Suche nach Zeichenketten. Es gibt ziemlich viele Treffer. Sie wird durch Eingabe von "def method name" und doppeltem Anführungszeichen eingegrenzt.

3. Verwenden Sie die Show-Source-Funktion von Pry-Docs

In der Rails-Konsole "$ " ODER "show-source "
Zeigt von def bis zum Ende des Definitionsteils an!
Der Pfad wird ebenfalls angezeigt, sodass Sie ihn mit Befehl + Klick im Editor anzeigen können.
Nachteil: Wenn Sie user.method überprüfen möchten, müssen Sie eine Benutzerinstanz erstellen, bevor Sie sie überprüfen können.

4. Verwenden Sie Prys "Schritt" -Funktion

Wenn Sie bei binding.pry gestoppt sind, können Sie diese Methode durch Ausführen von step "eingeben".
Sie können auch den Prozessablauf und die Variablendefinitionen für ein tieferes Verständnis anzeigen.
Sie können auch tiefe Stellen wie Rails / Gem sehen.
Nachteile: Es ist schwierig, bind.pry festzulegen und den Prozess zu stoppen.

Pikawaka [Rails] Gründliche Erklärung zu Pry!

Wenn außerhalb des Projekts definiert, z. B. Gem

1. Suche nach Dash

Dash ist ein Tool, mit dem verschiedene Dokumente wie Ruby, Rails, Gem und JavaScript durchsucht werden können.
Zusätzlich zum Quellcode ist es leicht zu verstehen, da es eine Beschreibung der Methode enthält.
Durch Hinzufügen der Erweiterung "Dash" zu VSCode können Sie mit Befehl + H zur Dash-Suche springen.
Nachteil: Manchmal gibt es keinen Edelstein, den Sie überprüfen möchten

2. `Bundle Show <Edelsteinname>`

Da das Verzeichnis angezeigt wird, in dem Gem installiert ist, kann VSCode per Befehlstaste in einem separaten Fenster geöffnet werden.
Nachteile: git und pry können nicht verwendet werden, daher müssen Sie die Methode finden, indem Sie den Editor durchsuchen.

3. Verwenden Sie Prys "Schritt" -Funktion

Wie bei den im Projekt definierten Methoden.

4. Geben Sie im Browser das Suchfenster von Github ein und suchen Sie nach "in diesem Repository".

Wie bei den im Projekt definierten Methoden.

Andere

1. Verwenden Sie Rubymines Quellensprung

Ich habe es nie benutzt, weil ich ein VS-Code-Benutzer bin. Ich bin jedoch der Meinung, dass Dash die Definitionen in Ruby, Rails und Gem fast abdecken kann.
Nachteile: teuer, langsam

2. Verwenden Sie die VS-Code-Erweiterung Solargraph

Platzieren Sie den Cursor einfach auf einer Ruby-Methode, um deren Dokumentation und Verwendungsbeispiele anzuzeigen.
Es gibt auch eine ergänzende Funktion
Nachteile: Es ist schmerzhaft, wenn Sie Docker verwenden. Solargraph muss seinen Sprachserver am Laufen halten. Sie müssen den Solargrap-Container starten und den Port auf VS-Code setzen. Referenz: Verwendung von Solargraph in Docker-Umgebung

Schließlich

Ich würde gerne wissen, wie man es überprüft.
Wenn es einen anderen guten Weg gibt, lass es mich bitte in den Kommentaren wissen m (_ _) m

[RUBY] Speicherort der Methodendefinition Zusammenfassung der zu überprüfenden Informationen Wenn im Projekt und in Rails / Gem definiert