जेएसडीओसी - कुछ कोड को पार्स किए जाने के लिए चिह्नित करें लेकिन दस्तावेज़ीकरण बनाए रखें?

Question

मैं JSDoc के साथ एक जावास्क्रिप्ट फ़ाइल दस्तावेज़ के लिए कोशिश कर रहा हूँ (3) इतने की तरह:

/** 1 if gnome-bluetooth is available, 0 otherwise        
* @type {boolean}                
* @const                                   
*/                    
const HAVE_BLUETOOTH = @HAVE_BLUETOOTH@;          

अब फ़ाइल (config.js.in कहा जाता है) का अपना मान्य Javascript पर नहीं है, फ़ाइल मेकफ़ाइल के माध्यम से चलती है जो @HAVE_BLUETOOTH@ के लिए उपयुक्त मान को प्रतिस्थापित करती है।

जब मैं इस पर जेएसडोक चलाने की कोशिश करता हूं, तो फ़ाइल में वाक्यविन्यास त्रुटि के कारण यह (समझदारी से) बाल्क होता है।

वहाँ किसी तरह इस फ़ाइल में सभी कोड की अनदेखी करने लेकिन बस एनोटेशन को ध्यान में रखना JSDoc बताने के लिए है? (मुझे कोड से दस्तावेज़ को पूरी तरह से अलग करने के लिए प्रत्येक डॉकलेट में @name टैग जोड़ना पड़ सकता है; यह ठीक है)।

कुछ की तरह:

/** 1 if gnome-bluetooth is available, 0 otherwise        
* @name HAVE_BLUETOOTH 
* @type {boolean}                
* @const                 
*/      
/** @ignore */ // somehow ignore from here onwards 
const HAVE_BLUETOOTH = @HAVE_BLUETOOTH@; 
/** !@ignore */ // somehow don't ignore from here onwards (although I'd be happy 
       // to ignore the entire file) 

मैं, फ़ाइल के कोड हिस्से को संशोधित करना नहीं चाहते हैं यदि संभव हो तो (मैं एक मौजूदा परियोजना के लिए प्रलेखन जोड़ रहा)। उदाहरण के लिए, मैं शायद के साथ उसके चारों ओर हो सकता है

const HAVE_BLUETOOTH = parseInt('@HAVE_BLUETOOTH@', 10); 

जो फ़ाइल बनाना होगा ताकि पार्सर शिकायत नहीं है मान्य जे एस वाक्य रचना फिर से है, लेकिन यह भी मतलब मैं मूल फ़ाइल की कोड को संशोधित कर रहा हूँ जो मैं टालना चाहता हूं (मैं को प्रलेखन जोड़ें) पसंद करता हूं।

चियर्स

Answer 1

मेरे मामले समान क्योंकि मैं JSDoc का उपयोग अपने .less और .css फ़ाइल टिप्पणी करने के लिए है। जब मैं फ़ाइल के सेट पर JSDoc चलाता हूं, तो मेरे पास एक ही समस्या है।

{ 
    "source": { 
     "includePattern": ".+\\.(css|less)?$" 
    }, 
    "plugins": [ 
     "plugin/commentsOnly" 
    ] 
} 

साथ

:

तो, मैं commentsOnly JSDoc प्लगइन

• https://github.com/jsdoc3/jsdoc/blob/master/plugins/commentsOnly.js

मैं इस config.json बनवाने के साथ मेरी समस्या (JSDoc 3.3.3) के साथ हल commentsOnly.js फ़ाइल को plugin/ निर्देशिका में दर्ज करें (पर विचार करेंऔर config.json एक ही फ़ोल्डर) में और इस फ़ोल्डर मैं निम्नलिखित CLI आदेश पर अमल में हैं:

jsdoc -c ./config.json ./assets/stylesheets/common.less 

और यह काम है! ऐसा कोई कारण नहीं है कि यह आपकी फाइलों के साथ काम न करे।

आशा है कि मैं आपकी मदद करूंगा;)