Dokument, das YARD den Rückgabetyp einer Instanzmethode verwendet, die die Instanz der Klasse

Question

zurückgibt. Ich konnte dies nirgendwo finden, einschließlich der Yard-Dokumentation.

Ich möchte den Rückgabetyp einer Instanzmethode dokumentieren. Zum Beispiel

class Foo 
    def initialize 
    end 
end 

Ich dokumentieren sie als

@return [???] returns the instance of `Foo` 

Was soll ich in schreiben ??? Sollte es Foo sein?

Answer 1

Richtig, wie pro tags overview es erwähnt folgende:

Klasse oder Modultypen

Jeder ist Ruby-Typ als Klasse oder Modultyp erlaubt. Ein solcher Typ ist einfach der Name der Klasse oder des Moduls.