Qt 5.11 - Including Code Inline

जिसमें कोड इनलाइन भी शामिल है




qt

जिसमें कोड इनलाइन भी शामिल है

निम्न आदेशों का उपयोग स्वरूपण के बिना स्रोत कोड को प्रस्तुत करने के लिए किया जाता है। स्रोत कोड एक नई लाइन पर शुरू होता है, कोड में प्रदान किया जाता है।

नोट: हालाँकि इनमें से अधिकांश कमांड C ++ कोड को रेंडर करने के लिए हैं, दूसरों पर \snippet और \codeline कमांड पसंद किए जाते हैं। ये आदेश अन्य Qt भाषा बाइंडिंग के लिए समान कोड स्निपेट को दस्तावेज़ीकरण में C ++ स्निपेट के लिए प्रतिस्थापित करने की अनुमति देते हैं।

\ कोड

\ कोड और \ एंडकोड आदेश स्रोत कोड का एक स्निपेट संलग्न करता है।

नोट: \c कमांड का उपयोग एक वाक्य के भीतर छोटे कोड अंशों के लिए किया जा सकता है। \ Code कमांड लंबे कोड स्निपेट के लिए है। यह एक HTML <pre> तत्व में एक अलग पैराग्राफ में कोड वर्बेटीम को प्रस्तुत करता है, और संलग्न स्निपेट को पार्स करता है, जो कोड में किसी भी ज्ञात प्रकार के लिंक बनाता है।

कमांड-लाइन निर्देश, शेल स्क्रिप्ट या किसी भी सामग्री को प्रलेखित करने के लिए, जो QDoc द्वारा मान्यता प्राप्त Qt भाषा में नहीं है, इसके बजाय \badcode उपयोग करें।

किसी भी \newcode कोड, \newcode या \oldcode कमांड को \oldcode करते समय, QDoc सभी इंडेंटेशन को हटा देता है जो क्रिया / ब्लॉक कोड / a के भीतर सामान्य है *! ... * / टिप्पणी से पहले यह मानक इंडेंटेशन जोड़ता है।

नोट: यह \quotefromfile या \quotefile कमांड का उपयोग करके बाहरी रूप से उद्धृत कोड पर लागू नहीं होता है।

/ *!
    \code
        #include <QApplication>
        #include <QPushButton>

        int main(int argc, char *argv[])
        {
            ...
        }
    \ endcode
* /

QDoc इसे प्रस्तुत करता है:

#include <QApplication>
#include <QPushButton>

int main(int argc, char *argv[])
{
    ...
}

अन्य QDoc कमांड \ code ... \ endcode के भीतर अक्षम हैं, और विशेष वर्ण '\' को बाकी कोड की तरह स्वीकार और रेंडर किया गया है।

किसी बाहरी फ़ाइल से कोड स्निपेट शामिल करने के लिए, \snippet और \codeline कमांड का उपयोग करें।

यह भी देखें कि \c , \badcode , \quotefromfile , \newcode , और \oldcode

\ badcode

\ Code के समान, \ badcode और \ endcode एक अलग अनुच्छेद में वर्बटिम प्रदान की गई सामग्री को संलग्न करता है, लेकिन कोई पार्सिंग या स्वचालित लिंक निर्माण नहीं किया जाता है। इसके बजाय, सामग्री को सादे पाठ के रूप में माना जाता है।

कमांड-लाइन निर्देश, शेल स्क्रिप्ट या किसी अन्य सामग्री का दस्तावेजीकरण करते समय इस कमांड के साथ सब्स्टीट्यूट कोड, जो कि क्यूटी भाषा में नहीं है, लेकिन फिर भी एक कोड कोड के समान स्टाइल किया जाना चाहिए।

\ newcode

\ Newcode, \ oldcode, और \ endcode कमांड्स आपको यह दिखाने में सक्षम करते हैं कि एक एपीआई के नए संस्करण में कोड का एक स्निपेट कैसे पोर्ट किया जाए।

\ Newcode कमांड और उसका साथी the \ oldcode कमांड the \ code कमांड का एक सुविधा संयोजन है: यह संयोजन दो कोड स्निपेट को एक दूसरे से संबंधित पाठ प्रदान करता है।

\ Newcode कमांड को पूर्ववर्ती \ oldcode कथन की आवश्यकता होती है।

\ Code कमांड की तरह, \ newcode कमांड अपने कोड को एक मोनोपेस फॉन्ट और मानक इंडेंटेशन का उपयोग करके प्रलेखन में एक नई लाइन पर प्रस्तुत करता है।

/ *!
    \oldcode
        if (printer->setup(parent))
            ...
    \newcode
        QPrintDialog dialog(printer, parent);
            if (dialog.exec())
                ...
    \ endcode
* /

QDoc इसे प्रस्तुत करता है:

उदाहरण के लिए, यदि आपके पास कोड जैसा है

if (printer->setup(parent))
    ...

आप इसे फिर से लिख सकते हैं

QPrintDialog dialog(printer, parent);
    if (dialog.exec())
        ...

अन्य QDoc कमांड \ oldcode ... \ endcode के भीतर अक्षम हैं, और '\' वर्ण को भागने की आवश्यकता नहीं है।

\ oldcode

\ Oldcode कमांड को एक संबंधित \ newcode स्टेटमेंट की आवश्यकता होती है; अन्यथा QDoc कमांड को पार्स करने में विफल रहता है और एक चेतावनी का उत्सर्जन करता है।

यह भी देखें \newcode

\ qml

\ Qml और \ endqml कमांड QML स्रोत कोड का एक स्निपेट संलग्न करता है।

/ *!
    \qml
        import QtQuick 2.0

        Row {
            Rectangle {
                width: 100; height: 100
                color: "blue"
                transform: Translate { y: 20 }
            }
            Rectangle {
                width: 100; height: 100
                color: "red"
                transform: Translate { y: -20 }
            }
        }
    \endqml
* /

QDoc इसे प्रस्तुत करता है:

import QtQuick 2.0

Row {
    Rectangle {
        width: 100; height: 100
        color: "blue"
        transform: Translate { y: 20 }
    }
    Rectangle {
        width: 100; height: 100
        color: "red"
        transform: Translate { y: -20 }
    }
}