लाइब्रेरीज़/नेमस्पेस के लिए क्लोजर प्रलेखन

Question

संपूर्ण रूप से क्लोजर libaries/नेमस्पेस को डॉकस्ट्रिंग और/या टिप्पणियां कैसे जोड़ें, यानी नामस्थान के भीतर केवल विशिष्ट कार्यों के लिए नहीं?

मैंने देखा है कि क्लोजर स्रोत कुछ स्थानों पर (comment ...) का उपयोग करता है (example), क्या यह अनुशंसित है?

Answer 1

आप इसे ns घोषणा करने के लिए जोड़ सकते हैं:

(ns ^{:author "mikera" 
     :doc "My awesome library"} 
    foo.bar.core) 

उदाहरण आप लिंक वह भी करता है - तो यकीन नहीं है कि अगर यह तुम क्या मतलब है? लेकिन मुझे लगता है कि यह सबसे अधिक "मानक" है - इसे Codox और Autodoc जैसे दस्तावेज़ सिस्टम द्वारा उठाया जाएगा।

Answer 2

आप ns फ़ॉर्म में किसी भी नामस्थान में डॉकस्ट्रिंग जोड़ सकते हैं। है

(ns my.name.space 
    "Very cool namespace doing this and that." 
    (:require other.cool.stuff))