15
Rubycop gibi mesajlar verir. Bu sadece bir yorum değil, değil mi? Özel bir formata sahip olmalı ama hangisi? the Rubocop documentation itibarenÜst düzey sınıf dokümantasyonu
A
cevap
7
:
RuboCop Ruby statik kod analizörü. Kutunun dışında, Ruby Style Guide topluluğunda özetlenen kuralların çoğunu uygular.
Yakut Stil Kılavuzu "yorum" ama yorumlarda kılavuz bölümünü okuyarak, hızlı sınıfları ve modülleri yorumlama örneklerden anlayabilirsiniz "üst düzey sınıf belgelerine yorum Eksik" ifadesini kullanmaz bölüm tavsiye edilir.
Nedeni, rdoc kullanırken, kod/kod için referans oluşturmak için sınıflar/modüller için yorumlar, kendiniz için kod yazıp yazamayacağınız, bir takım veya genel sürüm için önemli olan bir şey kullanılacaktır. diğerleri.
# This shiny device polishes bared foos
class FooBarPolisher
...
HTH
19
WelcomeController’dir. Bu mesajı önlemek için sınıf tanımının üzerine bir yorum ekleyin. Bu mesajdan kurtulmanın başka yolları da olabilir. Ayrıntılar için [rubocop] (https://github.com/bbatsov/rubocop/) belgelerine bakın.
İlgili konular
- 1. Java'da en üst düzey sınıf nedir?
- 2. Kotlin'de üst düzey işlevden sınıf referansı alın
- 3. Android üst düzey etkinliğin üst düzey etkinliğinden etkin
- 4. Üst düzey paketler içe aktarma
- 5. Üst düzey işlevinin değişkenini kullanma
- 6. URL üst düzey kategorileri url
- 7. Sınıf Düzey Özelliği
- 8. CKağıt Üst Düzey XCode Proje Özellikleri
- 9. JComponent'in en üst düzey konteyneri nasıl alınır?
- 10. `örtük 'değiştirici üst düzey nesneler için kullanılamaz
- 11. Üst düzey javascript olaylarını test etme
- 12. React Native Android: Yöntem, bir üst düzey
- 13. piton setup.py Sdist yalnızca üst düzey modülü
- 14. Üst düzey tüketici bloğunda commitOffsets var mı?
- 15. Bu iki üst düzey işlev nasıl farklı?
- 16. Açıkça İlişkilendirmeden Üst Düzey Düğüm Alma Başlarken
- 17. Tüm üst düzey pencere javafx nasıl alınır?
- 18. Tüm üst düzey etki alanlarının listesi
- 19. NodeJS oturum nesnesine en üst düzey erişim
- 20. İçerik denetimleri üst düzey kontroller olmalı
- 21. Raylar - üst sınıf uyumsuzluğu
- 22. Değişken ve üst düzey paket adı arasındaki Java adı çakışması
- 23. Scala 2.10'da bir makro çağırma ile birkaç üst düzey sınıf oluşturmak mümkün olacak mı?
- 24. Google Voice API Dokümantasyonu
- 25. Lift-json'u bir üst sınıf
- 26. Aynı anda çalışan web çalışanı html5 en üst düzey
- 27. @JacksonInject with En üst düzey bir harita üzerinde @JsonCreator kullanın
- 28. Alt etki alanını üst düzey etki alanının klasörüne yönlendirin
- 29. Neden üst düzey işlevlerimin Haskell'de imzalara ihtiyacı var?
- 30. Node.js/Express/Mocha/Üst Düzey Dinlenme API - Boş İstek Gövde
Size bu durumda hangi bir "üst düzey sınıfının" için dokümantasyon "yorumunu" olması gerekir olduğunu söylüyor: öylesine güzel yapacak gibi basit bir açıklama söz konusu – vee
@vee Sınıf tanımının altına yorum eklemeye çalıştım. Teşekkürler. – DreamWalker
Gerçek bir yorum ekleme ihtiyacının üstesinden gelmek için dosyanın en üstünde #: nodoc: 'ekleyebilirsiniz –