मैं PHP विकास के लिए नया हूं, और मैं सोच रहा हूं कि समुदाय के पास टिप्पणियों का उपयोग करके कोड के इनलाइन दस्तावेज़ों के लिए कोई दिशानिर्देश हैं या नहीं। मुझे पाइथन के PEP 257 जैसे कुछ पसंद आएगा, लेकिन मैं एक लोकप्रिय दस्तावेज़ निष्कर्षण उपकरण, या यहां तक कि एक लोकप्रिय उत्पाद के दस्तावेज़ीकरण मानक द्वारा उपयोग किए जाने वाले प्रारूप के लिए बसूंगा।PHP में प्रलेखन के लिए एक मानक शैली है?
PHP के लिए API दस्तावेज़ों के सबसे व्यापक रूप से इस्तेमाल प्रपत्र phpDocumentor भी कहा जाता है phpdoc है। काफी सारे आईडीई phpDocumentor शैली API दस्तावेज़ों का उपयोग करके ऑटो-समापन संकेतों को बेहतर बनाने के लिए जानकारी निकालने में भी सक्षम हैं।
उपयोग phpdoc (बहुत जावाडोक के समान)
phpdoc पहली बात यह है कि मन में आता है है, http://www.phpdoc.org/
PEAR (PHP एक्सटेंशन और आवेदन भंडार) coding standards कि एक sample file phpDocumentor, साथ ही कुछ अन्य उपयोगी सम्मेलनों का उपयोग कर भी शामिल है पर एक नज़र डालें।
phpdoc (phpDocumentor) शैली सामान्य है। यह DocComments का उपयोग करता है जिसमें DocBlocks है।
<?php
/**
* This is a DocBlock for a function.
*/
function associatedFunction()
{
}
<?php
/**
* I belong to a file
*/
/**
* I belong to a class
*/
class Def
{
}
टैग और एनोटेशन:
<?php
/**
* A summary informing the user what the associated element does.
*
* A *description*, that can span multiple lines, to go _in-depth_ into the details of this element
* and to provide some background information or textual references.
*
* @param string $myArgument With a *description* of this argument, these may also
* span multiple lines.
*
* @return void
*/
function myFunction($myArgument)
{
}