2014-11-04 7 views
6

यह वास्तव में एक नौसिखिया सवाल है।PHPdoc में टैग @Author को अपडेट करने के लिए कब?

मैं PHP के साथ अपने कौशल में सुधार करने की कोशिश कर रहा हूं, इसलिए मैं कुछ पुस्तकालयों का कोड पढ़ रहा हूं। मैंने देखा है कि कई phpdoc हेडर (यह सही नाम है मैं इसका मतलब यह:

/** 
* @param $config 
* @return bool 
* @author developer1 
*/ 

) @author टैग होते हैं।

मान लें कि डेवलपर 2 डेवलपर 1 के फ़ंक्शन में बड़े बदलाव करता है और फिर जिथब में जाता है। डेवलपर 2 को @Author टैग अपडेट करना चाहिए?

सामान्य अभ्यास क्या है?

+0

आप PHP कौशल में सुधार करने के लिए देख रहे हैं, तो आप शायद एक प्रलेखन प्रणाली है कि अभी भी बनाए रखा है का उपयोग करना चाहिए 2000 से रिलीज। मुझे इसे एक PHP प्रश्न के रूप में नहीं देखा गया है, वास्तव में - यह कुछ है जो आप लाइसेंस, अपनी टीम और मूल लेखक के साथ निर्धारित करेंगे। – ceejayoz

+0

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.author.pkg.html –

+0

लेखक आमतौर पर केवल व्यक्ति या व्यक्ति हैं जो मूल रूप से फ़ाइल को बनाते/संकल्पनाबद्ध करते हैं। – Flosculus

उत्तर

4

phpDocumentor 2 समर्थन कई @author टैग: - phpdoc एक नहीं पड़ा है

/** 
* Class User 
* @author Styx 
* @author second author 
* @package Application\Model 
*/ 
class User 
{ 
} 

http://www.phpdoc.org/docs/latest/references/phpdoc/tags/author.html

+0

धन्यवाद! मैं लगभग 1 चीज उलझन में हूँ। @seejayoz ने कहा कि PHPdoc अब और बनाए रखा नहीं है। क्या यह phpDocumentor 2 इसके उत्तराधिकारी है? – wwr

+2

@wwr phpDocumentor और Doxygen लोकप्रिय प्रतिस्थापन हैं। – ceejayoz

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