PHP मानक लेखक शीर्षलेख टिप्पणियां

Question

PHP शीर्षलेख टिप्पणियों के लिए मुझे किस प्रारूप का उपयोग करना चाहिए?

क्या यह पीयर के लिए समान है जैसा कि http://pear.php.net/manual/en/standards.header.php पाया गया है?

क्या शामिल होना चाहिए?

<?php 

/** 
* database.php 
* 
* Database access 
* 
* @category CategoryName 
* @package PackageName 
* @author  Mike 
* @copyright 2013 Mike 
* @license http://www.php.net/license/3_0.txt PHP License 3.0 
* @version CVS: $Id:$ 
* @link  http://pear.php.net/package/PackageName 
* @see  NetOther, Net_Sample::Net_Sample() 
* @since  File available since Release 1.2.0 
* @deprecated File deprecated in Release 2.0.0 
*/ 

?> 

क्या कोई यह बता सकता है कि इनमें से प्रत्येक वास्तव में लेखक और कॉपीराइट के अलावा क्या है।

क्या संस्करण संख्या दर्ज करना प्रोग्रामर दिखाने के अलावा कुछ और करता है? क्या इसे सिस्टम द्वारा ही इस्तेमाल किया जा सकता है?

@package और @category इन दोनों क्या करते हैं? और फिर, क्या वे सिस्टम द्वारा उपयोग किए जाते हैं या यह पूरी तरह से प्रोग्रामर के लिए है?

Answer 1

PHPDoc दस्तावेज़ देखें। इसमें सभी टैग के स्पष्टीकरण शामिल हैं।

https://phpdoc.org/docs/latest/index.html

Answer 2

के बाद से नाशपाती सिर छोटे अद्यतन के साथ PHP4 कोड के लिए बनाया गया था PHP5 के साथ काम करने मैं मौजूदा मानकों के साथ लाइन में अधिक कुछ के रूप में देखने के लिए चाहते हैं। @package और @ श्रेणी कुछ ऐसा था जो पीईएआर PHP नामों से पहले कोड को विभाजित करता था। सभी नए कोड का उपयोग उनको नहीं करना चाहिए, सिवाय इसके कि आप अपने कोड को विचलित करने के लिए पीयर का उपयोग करने की योजना बना रहे हैं। चूंकि किसी और ने पहले से ही phpDoc के लिए लिंक दिया है, यह उपलब्ध टैग के बारे में जानने के लिए सबसे अच्छी जगह है। मैं उन अन्य प्रमुख परियोजनाओं को भी देखता हूं जो आपको गिटहब पर मिलते हैं और अन्य साइटें सबसे आम टैग के साथ समान लेकिन अधिक अद्यतन शैलियों का उपयोग करती हैं।

Answer 3

PHPDoc.org @author टैग देखें।

सिंटेक्स

@author [name] [<email address>] 

उदाहरण

/** 
    * @author My Name 
    * @author My Name <my.name@example.com> 
    */