डॉक्सिजन या PHPDoc

Question

के साथ पैरामीटर्स प्राप्त/पोस्ट करने के लिए दस्तावेज़ मैं PHPDoc के लिए प्रलेखन को देख रहा था और पोस्ट वैरिएबल को दस्तावेज करने का एक अच्छा तरीका नहीं मिला जिसे मैं विभिन्न तरीकों से भेज रहा था।

तो, मैंने उम्मीदों के साथ डॉक्सिजन में देखना शुरू कर दिया कि यह मुझे इन सभी चरों को दस्तावेज करने का एक बेहतर तरीका प्रदान करेगा। मेरे कोड में बहुत से AJAX अनुरोध शामिल हैं, इसलिए अधिकांश चर पोस्ट के माध्यम से भेजे जाते हैं।

क्या मेरे लिए डॉक्सिजन में पोस्ट चर को दस्तावेज करने का कोई अच्छा तरीका है? मुझे यह निर्धारित करने में समस्या हो रही है कि मुझे मानक पैरामीटर टैग के साथ चलने में कोई त्रुटि मिलेगी या नहीं।

यदि नहीं, तो क्या कोई अन्य दस्तावेज है जो इस प्रक्रिया में सहायक हो सकता है? या क्या मुझे बस मैन्युअल रूप से दस्तावेज़ लिखना चाहिए और एक स्वचालित दस्तावेज़ उपकरण की तलाश करना चाहिए?

धन्यवाद!

Answer 1

तरीकों $ _POST से सीधे उन पढ़ रहे हैं, बल्कि विधि तर्कों के रूप से, तो मैं विधि के docblock में @uses टैग पर दुबला चाहते हैं:

/** 
* My foo() method 
* @return void 
* @uses $_POST['bar'] directly 
*/ 
public function foo() 
{ 
    echo "I use ", $_POST['bar'], "... :-)"; 
} 

एक अन्य विकल्प @global टैग हो सकता है :

/** 
* My bar() method 
* @return void 
* @global mixed uses the 'bar' key from the $_POST superglobal directly 
*/ 
public function foo() 
{ 
    global $_POST; 
    echo "I use ", $_POST['bar'], "... :-)"; 
} 

मुझे लगता है कि "वैश्विक" एक प्रणाली के अंदर एक superglobal के लिए तकनीकी रूप से आवश्यक नहीं है, लेकिन यह यह करने के दस्तावेज में मदद करता है।

---

संपादित

ध्यान दें कि phpdoc के संदर्भ गाइड के अनुसार, @uses एक दोतरफा संबंध दिखाने के लिए करना है।

प्रलेखन जनरेटर, इस्तेमाल किया-से टैग प्राप्त तत्व का प्रलेखन कि

इस प्रकार @uses टैग के साथ संबद्ध तत्व करने के लिए वापस लिंक में एक @ बनाना चाहिए, हालांकि शब्दार्थ @uses बेहतर पढ़ सकता है , @see का उपयोग $ _ [POST | GET | REQUEST] पैरामीटर को दस्तावेज़ करने के लिए भी किया जा सकता है। दोनों के बीच मुख्य/एकमात्र अंतर यह है कि @see FQSEN के लिए एक-तरफा लिंक होना है जो दस्तावेज़ ब्लॉक