En iyi Ruby kaldırılmış kodu işaretlemek için pratik?
İtiraz yöntemi olarak işaretlemek istiyorum, insanların kolayca kendi kod kontrol edebilirsiniz kullanarak onu yakalamak. Java @Onaylanmadı ayarlayın ve herkes bunun anlamını biliyor.
Yani Ruby ve amortismanlar için işareti kontrol etmek için tercih edilen bir yol (veya araçlar).
CEVAP
Hemen hemen tüm durumlarda, bir kütüphane bağlı olarak ya da kaldırılması için metaprogramming abartılı olur. Sadece rdoc için bir yorum eklemek ve Kernel#warn
yöntemini çağırın. Örneğin:
class Foo
# <b>DEPRECATED:</b> Please use <tt>useful</tt> instead.
def useless
warn "[DEPRECATION] `useless` is deprecated. Please use `useful` instead."
useful
end
def useful
# ...
end
end
Eğer rdoc doktor yorum yerine Yard kullanıyorsanız bu gibi görünmelidir:
# @deprecated Please use {#useful} instead
Senin için uygun değilse son olarak, tomdoc, yorum şöyle:
# Deprecated: Please use `useful` instead
İtiraz: bu yöntem önerilmiyor Gösterir ve gelecekteki bir sürümüne kaldırılacaktır. Kamu vardı ama bir sonraki sürümde de kaldırılacak belge için bu yöntemleri kullanmak GEREKİR.
Ayrıca,biraz ileride artık kullanılmayan bir yöntem (ve düzgün semver'd) serbest bırakın . kaldırmak için unutma . Java kütüphanelerini yaptığım hataları yapma.
Nasıl ilan ya da kaldırılmış gibi bir ...
Nasıl Ruby alt veya üst durumda bir di...
Nasıl Ruby rastgele bir sayı almak içi...
Neden Ruby Hariç => e `kurtarmak iç...
Güncelleme ve silme için HTTP durum ko...