Wie YARD Dokument eine Methode, die nichts zurückgibt

Ich habe eine Methode wie dieseWie YARD Dokument eine Methode, die nichts zurückgibt

def self.import(file_name, opts = {})

, die ich mit YARD zu dokumentieren bin versucht. Allerdings ist dies eine Methode, die 100% Nebenwirkung ist (ich weiß, ich weiß, Nebenwirkungen, urgh!). Aber für Anwender dieser Methode wird effektiv kein Objekt beliebigen Typs zurückgegeben, jedoch YARD erzeugt eine Signatur wie folgt aus:

+ (Object) import(file_name, opts = {})

Gibt es eine Möglichkeit Hof zu sagen, dass die Import-Methode nichts zurückgibt?

Ich kann es sagen Null zurück, aber das ist nicht wirklich die gleiche Sache

Quelle

2014-09-07 Jamie Cook

sollte das Verfahren öffentlich sein? Es scheint, als wäre es ein Nebeneffekt, dass nur andere Methoden darauf zugreifen können. Daher muss es keine öffentliche Methode sein ... – Anthony

Da Ruby-Methoden normalerweise den Rückgabewert des letzten Ausdrucks zurückgeben, bin ich irgendwie interessiert wie deine Methode aussieht wie. – spickermann

Ja, diese Methode sollte öffentlich sein, da sie der einzige zugängliche Einstiegspunkt für eine Klasse ist (der Ruby wird innerhalb eines Containerprogramms ausgeführt und diese Klasse importiert benutzerdefinierte Daten in dieses Programm) –

Alle Methoden etwas zurückgeben, die Leere Schlüsselwort sein könnte, was sie suchen.

# @return [void] 
def method_returning_unknown_object 
end

void return rendering

Quelle

2014-09-16 11:31:31

Ich bin weg von meinem Windows-Rechner atm ... welche Art von Signatur erzeugt das? –

Wie YARD Dokument eine Methode, die nichts zurückgibt

Antwort

Verwandte Themen