phpdoc में @package और @subpackage का उपयोग कैसे करें?

Question

मुझे आश्चर्य है कि मुझे क्लास डॉक के लिए @package & @subpackage का उपयोग कैसे करना चाहिए।

देना कहते हैं कि मैं निम्नलिखित वर्ग है

class My_Controller_Action_Helper_MyHelperAction extends Foo_Bar {} 

यह होना चाहिए:

@category My 
@package  Controller 
@subpackage Action_Helper 

या

@category My 
@package  Controller 
@subpackage Action_Helper_MyHelperAction 

या

@category My 
@package  Controller_Action 
@subpackage MyHelperAction 

या

@category My 
@package My_Controller_Action 
@subpackage MyHelperAction 

क्या होगा अगर बजाय '_' उपयोग नाम स्थान?

Answer 1

पहला: यदि आप "_" या "\" (नेमस्पेस सेपरेटर) का उपयोग अपने निर्णय को प्रभावित नहीं करते हैं, तो आप अपनी कक्षाओं को कैसे एनोटेट करते हैं। अंडरस्कोर "_" प्री-नेमस्पेस युग से आता है और नामस्थान विभाजक की तरह कार्य करता है, सिवाय इसके कि यह कोई नामस्थान नहीं बनाता है। इसलिए "My_Controller_Action" को "My_Controller" में "एक्शन" के रूप में माना जाना चाहिए।

लेकिन, आप कैसे उपयोग @package और/या @subpackage वास्तव में अपने निर्णय है। उदाहरण के लिए मैं @category का उपयोग नहीं करता हूं और @subpackage "दूसरा" नामस्थान के बाद सब कुछ है। मुझे समझाएं: मैं पीएसआर -0 मानक का पालन करता हूं, जहां पैकेज को \<Vendorname>\<packagename>\<subpackage>\... (या संस्करण के आधार पर "\" के बजाय "_" में संरचित किया गया है)। फिर @package <vendorname>.<package> और @subpackage <subpackage>।

निष्कर्ष: यह आपके ऊपर है :) आपके द्वारा उपयोग किए जाने वाले टैग और आप उनका उपयोग करने के आधार पर एक दस्तावेज़कर्ता आपके कोड की विभिन्न संरचनाओं को भूगर्भित कर सकता है। बस इसे आज़माएं।

Answer 2

मैं पैकेज के नाम के लिए @package का उपयोग करता हूं, यह फ़ाइल संबंधित है ... आश्चर्य :) उदाहरण के लिए यदि यह प्लगइन उस पैकेज में मौजूद सभी फ़ाइलों के लिए xyz @package कहा जाता है।

डॉक्सिजन (जो मैं उपयोग करता हूं) के लिए @subpackage जैसी कोई चीज़ नहीं है, हालांकि आप अपना स्वयं का बना सकते हैं। उदाहरण के लिए: http://www.stack.nl/~dimitri/doxygen/commands.html

Doxygen आप के लिए @package my.awesome.package की तरह कुछ है जो इसे में टूट जाती है का उपयोग कर सकते 'उप संकुल'

आप वास्तव में जब तक कुछ भी करने के लिए उपयोग कर सकते हैं के रूप में यह समझ में आता है और है संगत। सबसे पहले तय करें कि आप क्या उपयोग करना चाहते हैं और फिर उस एप्लिकेशन के लिए सिफारिशों/दस्तावेज़ों को देखें क्योंकि वे सभी अलग हैं