डॉक्सिजन

Question

के साथ लिंट टिप्पणियों का उपयोग दस्तावेज के लिए, हमें आमतौर पर एक अतिरिक्त दस्तावेज़ बनाना होता है जो वर्णन करता है कि हमने क्या किया है जब कोड (e.g. /* lint --e228) में किसी भी लिंट संदेश अक्षम किए गए थे। यह doxygen के साथ इसका उपयोग करना अधिक आसान बना देगा (जैसा कि हम इसे किसी भी तरह बनाते हैं)।

हालांकि, मैं doxygen इन लिंट टिप्पणियों का उपयोग करके किसी भी समाधान को खोजने में सक्षम नहीं था। क्या किसी ने इसे आजमाया? क्या कोई समाधान है stric '/*lint' का उपयोग कैसे करें, लेकिन इसे किसी भी तरह से doxygen पर जोड़ें?

धन्यवाद!

Answer 1

यह लिंट अभिव्यक्ति टिप्पणी में विस्तार करने के लिए मैक्रो को परिभाषित करके पूरा किया जा सकता है, लेकिन doxygen द्वारा विस्तारित होने पर मैक्रो को एक अलग टिप्पणी में विस्तारित किया जा सकता है।

#ifndef LINT_CONTROL 
#define LINT_CONTROL(X) /*lint -save X */ //lint X 
#endif 

int main() { 
    int a; LINT_CONTROL(-e530) 
    return a != a; 
} 

फिर, अपने doxygen विन्यास फाइल में, आप कुछ पूर्वप्रक्रमक मैक्रो के विस्तार सक्षम कर सकते हैं:

चाल पीसी फाहा ^टीएम या FlexeLint ^टीएम को -save अनुदेश का प्रयोग है। विशेष रूप से, हम को doxygen-बजाय टिप्पणी में विस्तारित करने के लिए बदल सकते हैं।

ENABLE_PREPROCESSING = YES 
MACRO_EXPANSION  = YES 
EXPAND_ONLY_PREDEF  = YES 
PREDEFINED    = "LINT_CONTROL(X)=//! lint control: X" 

वैकल्पिक रूप से, अगर आप FlexeLint ^टीएम है, तो आप डूबा स्रोत को संशोधित कर सकते हैं ताकि एक Doxygen टिप्पणी फाहा नियंत्रण को गति प्रदान करने के लिए इस्तेमाल किया जा सकता है। तकनीक का वर्णन Gimpel Software Discussion Forum पर किया गया है।

_{पीसी-लिंट और फ्लेक्सलिंट गिंपेल सॉफ्टवेयर के ट्रेडमार्क हैं।}