মন্তব্যে "# @ +" এবং "# @ -" স্ট্রিংগুলির অর্থ কী?

15

আমি কিছু ম্যাজেন্টো 2 শ্রেণির মন্তব্যে প্রচুর "# @ +" এবং "# @" "স্ট্রিং দেখছি। \Magento\Customer\Api\Data\AttributeMetadataInterface

interface AttributeMetadataInterface extends \Magento\Framework\Api\MetadataObjectInterface
{
    /**#@+
     * Constants used as keys of data array
     */
    const ATTRIBUTE_CODE = 'attribute_code';
    ...
    const IS_SEARCHABLE_IN_GRID = 'is_searchable_in_grid';
    /**#@-*/
    ...
}

এই চিহ্নিতকারীগুলির উদ্দেশ্য কী?

— অ্যালেক্স গুসেভ
সূত্র

14

এই অক্ষরগুলি একটি পিএইচপিডোক ডকব্লক টেম্পলেট ঘোষণা করতে ব্যবহৃত হয় :

একটি ডকব্লক টেমপ্লেটের উদ্দেশ্য হ'ল রিডানড্যান্ট টাইপিং হ্রাস করা। উদাহরণস্বরূপ, যদি বিপুল সংখ্যক শ্রেণীর ভেরিয়েবলগুলি ব্যক্তিগত হয় তবে তাদের ব্যক্তিগত হিসাবে চিহ্নিত করতে কোনও ডকব্লক টেম্পলেট ব্যবহার করবে। ডকব্লক টেমপ্লেটগুলি টেমপ্লেট ব্লকে পাওয়া সাধারণ ডকব্লকগুলি কেবল বাড়িয়ে তোলে।

একটি ডকব্লক টেম্পলেটটি তার শিরোনামের দ্বারা একটি সাধারণ ডকব্লক থেকে পৃথক হয়।

/**#@+
 *
 */

এটি ডকব্লক টেমপ্লেট হিসাবে চিহ্নিত করে যে পাঠ্যটি "/ ** # @ +" - সমস্ত 6 টি অক্ষর উপস্থিত থাকতে হবে। ডকব্লক টেমপ্লেটগুলি শেষ হওয়া টেম্পলেট চিহ্নিতকারী না হওয়া পর্যন্ত সমস্ত ডকুমেন্টেবল উপাদানগুলিতে প্রয়োগ করা হয়:

/**#@-*/

নোট করুন যে পিএইচপিডোকামেন্টরকে সেগুলি টেমপ্লেট হিসাবে স্বীকৃতি দেওয়ার জন্য সমস্ত 8 টি অক্ষর অবশ্যই "/ ** # @ - * /" হিসাবে উপস্থিত হবে।

আরও তথ্য এখানে পাওয়া যাবে: http://codingexplained.com/coding/php/how-to-use-doc block-templates-in-phpdoc

অফিসিয়াল ম্যাজেন্টো ডকুমেন্টেশনে কিছু ব্যাখ্যা উপলব্ধ রয়েছে: http://devdocs.magento.com/guides/v2.0/coding-standards/doc block-standard- general.html

— ডিজিটাল পিয়ানিজমে রাফেল
সূত্র

6

যদি একই ধরণের একাধিক ধারাবাহিক উপাদানগুলির ঘোষণা হয় তবে ডকব্লকের একই বিষয়বস্তুগুলি সেগুলির সাথে প্রাসঙ্গিক হতে পারে। এই ক্ষেত্রে সেই উপাদানগুলির জন্য পৃথক ডকব্লকগুলি ডকব্লক টেম্পলেট দ্বারা প্রতিস্থাপিত হতে পারে।

ডকব্লক টেমপ্লেটটিতে দুটি ডকব্লক মন্তব্য রয়েছে:

মন্তব্য শুরু করা গোষ্ঠীর প্রথম উপাদানটির আগে, # @ + ব্যবহার করে বিশিষ্ট এবং নীচে বিন্যাসিত:

/**#@+
 *
 */

সমাপ্তি মন্তব্যটি গ্রুপের শেষ উপাদানটির পরে, # @ - ব্যবহার করে আলাদা এবং নীচে ফর্ম্যাট করা হয়েছে:/**#@-*/

উদাহরণস্বরূপ, একাধিক শ্রেণীর ধ্রুবক বা গুণাবলী ঘোষণা:

class Mage_Core_Model_Layout extends Varien_Simplexml_Config
{
    /**#@+
     * Supported layout directives
     * @var string
     */
    const TYPE_BLOCK = 'block';
    const TYPE_CONTAINER = 'container';
    /**#@-*/

    /**#@+
     * Scheduled structure elements operations
     *
     * @var array
     */
    protected $scheduledMoves   = array();
    protected $scheduledRemoves = array();
    /**#@-*/

এখানে রেফারেন্স

— প্রশান্ত ভালান্দা
সূত্র