6
Mam metodę jak tenJak YARD dokument to metoda, która zwraca nic
def self.import(file_name, opts = {})
które staram się dokumentować ze stoczni. Jednak jest to metoda, która jest w 100% efektem ubocznym (wiem, wiem, efekty uboczne, urgh!). Ale dla użytkowników tej metody nie jest efektywnie nie powrócił obiekt dowolnego typu, jednak YARD generuje podpis takiego:
+ (Object) import(file_name, opts = {})
Czy istnieje jakiś sposób, aby powiedzieć, że metoda stoczni import nic nie zwraca?
mogę powiedzieć to, aby powrócić nil, ale to naprawdę nie jest to samo
metoda powinna być publiczna? wydaje się być "efektem ubocznym", do którego mogą się odwoływać tylko inne metody, dlatego nie musi to być metoda publiczna ... – Anthony
Ponieważ metody Rubiego zwykle zwracają wartość zwracaną przez ostatnie wyrażenie, jestem zainteresowany jak wygląda twoja metoda. – spickermann
Tak, ta metoda powinna być jawna, ponieważ jest jedynym dostępnym dla użytkownika punktem wejścia do klasy (ruby działa z poziomu programu kontenerowego, a ta klasa importuje dane określone przez użytkownika do tego programu) –