में फ़ंक्शन ऑर्डर सहेजें, मैं अपनी प्रोजेक्ट पर phpdoc चला रहा हूं और वहां एक फ़ाइल (एकमात्र सार्थक फ़ाइल) है, जिसमें विधियों के समूह के तरीकों के लिए विधियों का क्रम महत्वपूर्ण है। स्रोत फ़ाइल में जनरेट किए गए दस्तावेज़ों में फ़ंक्शंस का एक ही क्रम कैसे हो सकता है?phpdoc
असल में, मैं दस्तावेज़ ढांचे को बदलने के लिए तैयार हूं, अगर यह मदद करता है।
मुझे लगता है कि एक विशिष्ट आदेश घोषित करना संभव नहीं है।
@package एस था, जो PHP में नामस्थानों के लिए है (afaik ..) बनाना संभव है।
यदि आपने @package घोषित किया है, तो आप @subpackage एस समूह विधियों/कार्यों को परिभाषित कर सकते हैं।
<?php
namespace Stackexchange\Stackoverflow;
/**
* My Answer
* @package Stackexchange\Stackoverflow
* @see http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.subpackage.pkg.html
*/
class Answer
{
/**
* @subpackage SomeSubGroup
* @return $this
*/
public function doSomething {
return $this;
}
/**
* @subpackage SomeOtherSubGroup
* @return $this
*/
public function doSomethingDifferent {
return $this;
}
}
समूहीकरण सुविधा के अलावा, आप शब्दार्थ और तार्किक छोटे, व्यापार भागों में बड़ी कक्षाओं विभाजित करके अपने कार्यक्रमों की सुधार करने के लिए प्रयास करना चाहिए।
फ़ंक्शन ऑर्डर को सुरक्षित रखने के लिए वैध कारण हैं जिनके पास खराब ओओ प्रथाओं से कोई लेना देना नहीं है। विशेष रूप से प्रलेखन में। – Cypher
दुर्भाग्य से, परियोजना की आवश्यकताओं ने मुझे ओओपी की सादे शैली कीड़े का उपयोग करके बनाया है। –
जांच एक PHP कार्यक्रम दस्तावेज़ के लिए चरणों के लिए नीचे यूआरएल,
http://pear.php.net/manual/en/package.php.phpdocumentor.intro.php
यह विशिष्ट प्रश्न को संबोधित नहीं करता है, लेकिन एक अच्छा संदर्भ है। उन्होंने प्रश्न को 'phpdoc' के साथ टैग किया और इसका उल्लेख किया, इसलिए मुझे लगता है कि वह सामान्य विचार जानता है। – ToothlessRebel
दुर्भाग्य से, यह प्रकट नहीं होता है वहाँ एक रास्ता Documenter क्या में तरीकों को सूचीबद्ध करने के क्रम में बताने के लिए है।
हालांकि, संबंधित कार्यों पर ध्यान आकर्षित करने के लिए @see उपयोगी हो सकता है। उस क्रम के बारे में पूर्ण विवरण में एक नोट के साथ, या ऑर्डर अपवादों में से कुछ शायद वर्तमान में पेश किए जा सकने वाले टूल का सबसे अच्छा हो सकता है।
मुझे आपका जवाब पसंद है और यदि कोई बेहतर उत्तर प्रदान नहीं किया जाता है तो मैं इसे उपहार के साथ पुरस्कार दूंगा। –
हालांकि यह कोई बुरा सवाल नहीं है, फ़ंक्शन/विधियों के क्रम पर भरोसा करना बुरा अभ्यास है (कम से कम PHP में)। – DanFromGermany
@DanFromGermany: हाँ, लेकिन शायद एक प्रलेखन दृष्टिकोण से आप संबंधित कार्यों को एक साथ समूहीकृत करना चाहते हैं। Php.net की तरह, जहां पीडीओ फ़ंक्शंस आदि के साथ सरणी फ़ंक्शन मिश्रित नहीं होते हैं ... – AbraCadaver
यदि आपके पास एकल PHP वर्ग/फ़ाइल के अंदर फ़ंक्शंस के कई समूह हैं - तो मैं आपको विभिन्न वर्गों/नामस्थानों में विभाजित करने का सुझाव दूंगा –