डेटा वर्र्स पर दस्तावेज़-स्ट्रिंग डालने पर, क्या इसे बेवकूफ माना जाता है?

Question

इसलिए मैंने अपने क्लोजर कोड में राज्य डेटा रखने के लिए कुछ वर्र्स परिभाषित किए हैं। मैं सिर्फ मैं उन वार्स उदा .:

(def ^{:doc "Documentation for *my-var*"} 
     *my-var*) 

मुझे आरईपीएल पर (doc *my-var*) फोन की सुविधा देता है कि करने के लिए कोई दस्तावेज़-स्ट्रिंग जोड़ सकते हैं की खोज की है। ऐसा करने के लिए एक वैध और उपयोगी चीज की तरह लगता है लेकिन यह मेरे द्वारा पढ़े गए (सीमित) कोड में सामान्य अभ्यास की तरह प्रतीत नहीं होता है।

क्या यह बेवकूफ क्लोजर माना जाता है?

Answer 1

इसके अलावा Clojure नेमस्पेस (clojure.pprint की तरह) में इस्तेमाल किया:

(def 
^{:doc "The base to use for printing integers and rationals." 
    :added "1.2"} 
*print-base* 10) 

आप clojure.contrib.def से एक सुविधा मैक्रो का उपयोग करने के लिए wan't हो सकता है:

(defvar *my-var* 
    nil 
    "Documentation for *my-var*") 

Answer 2

clojure 1.3 के बाद से

, def ने वैकल्पिक डॉकस्ट्रिंग की अनुमति दी है।

(def *my-var* 
    "My var does cool things (it really doesn't)." 
    nil)