2010-02-03 7 views
11

के साथ PHP स्थिरांक (परिभाषित) को दस्तावेज़ करने का सही तरीका क्या है? हमें PHP में define() के साथ परिभाषित स्थिरांक (phpDocumentor के साथ) को कैसे दस्तावेज करना चाहिए?phpDocumentor

मैं डॉक्स में कुछ भी नहीं मिला है, लेकिन निम्न उदाहरण पाया sample2.php में (जो मैं नहीं दिख रहा है यह फायदा नहीं है):

/**#@+ 
* Constants 
*/ 
/** 
* first constant 
*/ 
define('testing', 6); 
/** 
* second constant 
*/ 
define('anotherconstant', strlen('hello')); 

किसी को भी मुझे बता सकते हैं सबसे अच्छा तरीका स्थिरांक दस्तावेज़ के लिए क्या phpDocumentor के साथ PHP में?

उत्तर

6

परिभाषित विवरण सामान्य रूप से केवल एक वर्णनात्मक पाठ के साथ टिप्पणी की जाती है, इसलिए मूल रूप से आप इसे कैसे टिप्पणी करते हैं।

डॉकब्लॉक टेम्पलेट टैग, /**#@+ के बारे में अधिक पढ़ने के लिए, the manual page देखें।

+0

देखें होगा कोई विशेष टैग आवश्यक है। आपके उदाहरण के शीर्ष पर दिखाई देने वाला "टेम्पलेट टैग" केवल एक शॉर्टकट के रूप में होता है जो आपके प्रत्येक व्यक्तिगत विवरण ("पहला स्थिर", "दूसरा स्थिर") में * आपके "स्थिरांक" विवरण टुकड़ा जोड़ता है। उस टेम्पलेट टैग का उपयोग केवल तभी जरूरी है जब आप वास्तव में कुछ अलग टेक्स्ट को कई अलग-अलग विवरणों में रखना चाहते हैं। – ashnazg

+0

सभी लिंक मर चुके हैं – Loenix

0

आपके पास phpDoc.org the elements that can be documented पर है।

आपके पास an example of documenting a define() (कोड और आसपास के पैराग्राफ का दूसरा भाग) भी है।

+2

यह उदाहरण वास्तव में यह प्रदर्शित करने की कोशिश कर रहा है कि फ़ंक्शन foo() और फ़ंक्शन के डॉक्लॉक के बीच ग़लत ढंग से सैंडविच किए गए "परिभाषित" कथन को डॉकब्लॉक को फ़ंक्शन के बजाय परिभाषित स्थिरांक से गलत तरीके से संबद्ध किया जाएगा। मैं वास्तव में एक दस्तावेज़ को निरंतर दिखाने के लिए ट्यूटोरियल में एक उपयोगी उदाहरण नहीं देखता हूं, इसलिए मुझे phpDocumentor की फ़ाइलों में से एक में से एक मिला है ... यहां पृष्ठ के नीचे देखें (http://manual.phpdoc.org/ HTMLSmartyConverter/हाथ/__ filesource/fsource_phpDocumentor_Parsers_phpDocumentorConvertersXMLDocBookpeardoc2Tokenizer.php.html)। – ashnazg

+1

सभी लिंक मर चुके हैं – Loenix

+0

परियोजना ने प्रलेखन का स्थान बदल दिया। नया स्थान: https://phpdoc.org/docs/latest (क्षमा करें, मुझे आपके द्वारा पोस्ट किए गए अनुभाग नहीं मिल रहे हैं) – xOneca

1
/** 
*@const 
*/ 
const testing=6; 
const anotherconstant=strlen('hello'); 

इस प्रयास करें तो आप इसे के रूप में लगातार

संबंधित मुद्दे