2009-07-25 11 views
28

मुझे पता है कि PHP कोड इनलाइन दस्तावेज़ों के लिए कई अलग-अलग मानक हैं।आप अपने PHP फ़ंक्शंस और कक्षाओं को इनलाइन कैसे दस्तावेज करते हैं?

/** 
* This is the description for the class below. 
* 
* @package my-package 
* @subpackage my-subpackage 
* @author  my-name 
* @version my-version 
* ... 
*/ 
class orderActions { 
... 

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

मुझे मैनुअल बनाने में कोई दिलचस्पी नहीं है - मैं जानना चाहता हूं कि ऊपर दिए गए कोड के प्रकार को कैसे उत्पन्न करना है, या "इनलाइन दस्तावेज़"।

+0

आपके नवीनतम संपादन से आपका क्या मतलब है? मुझे इस इनलाइन दस्तावेज को कैसे उत्पन्न करना है, इसका मतलब आपको नहीं मिलता है। –

+0

क्षमा करें, स्पष्टीकरण के लिए: मैं पूछ रहा हूं कि उदाहरण में कोड टिप्पणी (या "इनलाइन दस्तावेज़") कैसे उत्पन्न करें। –

उत्तर

40

PHPDoc, जैसा आपने पोस्ट किया है, PHP दस्तावेज़ीकरण का व्यापक रूप से स्वीकार्य रूप है।

आप दस्तावेज़ों को स्वतः उत्पन्न करने के लिए Doxygen का उपयोग कर सकते हैं।

संपादित करें: अपने कोड में ऑनलाइन दस्तावेज उत्पन्न करने के मामले में, मैंने कभी ऐसा टूल नहीं देखा है जो वापस जायेगा और इसे एक परियोजना के लिए बाहर कर देगा। कोड के दौरान टेम्पलेट जेनरेट करने के लिए आम तौर पर आईडीई के दायरे में छोड़ा जाता है।

ग्रहण वास्तव में इसका एक सभ्य काम करता है (यह ग्रहण के बारे में मुझे कुछ चीजों में से एक है) और मेरा मानना ​​है कि नेटबीन भी करता है। किसी भी प्रमुख आईडीई में इस प्रकार की टेम्पलेट पीढ़ी के साथ सहायता करने की कार्यक्षमता होगी।

+3

PHPDocumentor शायद सबसे आम है और एपीआई दस्तावेज जोड़ने के लिए अनुशंसित तरीका है। –

+0

क्या PHPDoc के साथ इनलाइन दस्तावेज उत्पन्न करना संभव है? मैंने सोचा कि केवल दस्तावेज मैनुअल बनाने के लिए था। –

+0

+1 वास्तव में अच्छी तरह से काम करता है और netbeans के साथ एकीकृत करता है। –

0

हालांकि मैंने इसका पूरी तरह से उपयोग नहीं किया है, Doxygen इस कार्य के लिए आशाजनक दिखता है।

यदि आप जावा के लिए जावाडॉक टूल से परिचित हैं, तो यह काफी समान है। आप Doxygen शैली का उपयोग करते हैं और फिर दस्तावेज़ों का उत्पादन करने के लिए अपनी स्रोत फ़ाइलों पर उपकरण चलाते हैं।

1

आमतौर पर, आप अपने स्वयं के डॉकब्लॉक टिप्पणियां लिखेंगे, हालांकि मुझे लगता है कि कुछ आईडीई आपके लिए टेम्पलेट बना सकते हैं।

मैंने वास्तव में write a program, which can trace a running program and detect parameter types and write them back as docblock comments किया था। यह थोड़ा छोटी है, लेकिन यह काम करता है।

0

सुनिश्चित नहीं है कि आप किस कोड में हैं लेकिन मेरे पास कई स्निपेट हैं (मैं टेक्स्टमैट का उपयोग करता हूं) जो कि मैं अभी काम कर रहा हूं) में मैंने पाया है क्योंकि मैं विवरणों को भरने के बाद से यह सर्वोत्तम परिणामों के साथ समाप्त होता है मेरे लिए यह करने के लिए एक प्रणाली पर भरोसा करने के बजाय।

शुरू में अधिक काम है, लेकिन यह इसके लायक लंबे समय में

1

मैं बहुत उपयोग करने के लिए सरल और phpdoc के साथ संगत एक documentator बनाई गई प्रतीत हो रहा है:

उदाहरण:

<?php 
    $docs = new QuickDocumenter(); 
    $docs->parseString(" 
    /** 
    * Sanitize string 
    * 
    * @sinse  1.0 
    * @version 1.0 
    */ 
    "); 
    foreach($docs->result() as $doc) 
    { 
     highlight_string(print_r($doc , true)); 
     echo "<hr/>"; 
    } 
?> 

Github में देखें:

https://github.com/olaferlandsen/QuickDocumenter

अलविदा!

+0

@ sinse की वर्तनी @since होना चाहिए: ') –

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