نقطه ویرگول;

هر از گاهی از هر چیزی

هر از گاهی از هر چیزی

PHPDoc، قسمت سوم – Tags

شنبه, ۱۷ ارديبهشت ۱۳۹۰، ۱۰:۴۴ ب.ظ
تمام برچسپ ها اختیاری هستند اما اگر از یک برچسپ استفاده کردید باید خصوصیات آن برچسپ را رعایت کنید.

برچسپ استفاده توضیحات
@abstract مستند سازی کردن یک abstract کلاس، متد های و خصوصیات کلاس
@access Public، Private یا protected مستند سازی برای دسترسی کنترل به یک عنصر.
@author Author name مستند سازی ایجاد کننده عنصر جاری
@copyright Name date مستند سازی اطلاعات حق نشر
@deprecated Version مستند سازی یک متد بد !
@deprec کوتاه شده @deprecated
@example /path/to/example مستند سازی یک آدرس فایل که در آن یک مثال ذخیره شده است
@exception مستند سازی برای یک استثنا throw در یک متد. همچنین نگاه کنید به @throws
@global type $globalvarname مستند سازی یک متغییر سراسری یا استفاده در یک متد یا تابع
@ignore جلوگیری از مستندسازی یک عنصر
@internal اطلاعات خصوصی برای توسعه های پیشرفته
@link URL
@name global variable name انتخاب یک نام مجازی برای متغییر سراسری. برای نمونه $GLOBALS['myvariable'] می شود  $myvariable
@magic
@package name of a package مستندسازی گروهی از کلاس ها و توابع
@param type [$varname] description
@return type description این برچسپ برای متد construct و متد هایی که مقدار void را برگشت می دهند نباید استفاده شود
@see element مستند سازی رابته به یک عنصر دیگر(global variable, include, page, class, function, define, method, variable).
@since version مستندسازی یک متد اضافه شده به یک کلاس
@static مستند سازی سک کلاس یا یک متد static
@staticvar مستندسازی یک متغییر static استفاده شده در یک کلاس یا یک تابع
@subpackage
@throws مستند سازی برای یک استثنا throw در یک متد
@todo
@var type نوع داده در یک متغییر کلاس
@version ارایه یک شماره برای یک کلاس یا متد
موافقین ۰ مخالفین ۰ ۹۰/۰۲/۱۷

نظرات  (۱)

سری پست های خوبی رو شروع کردید. من که استفاده کردم.
همینطور ادامه بدید. ممنون

ارسال نظر

ارسال نظر آزاد است، اما اگر قبلا در بیان ثبت نام کرده اید می توانید ابتدا وارد شوید.
شما میتوانید از این تگهای html استفاده کنید:
<b> یا <strong>، <em> یا <i>، <u>، <strike> یا <s>، <sup>، <sub>، <blockquote>، <code>، <pre>، <hr>، <br>، <p>، <a href="" title="">، <span style="">، <div align="">
تجدید کد امنیتی